An explicit key or prefix for identifying the cache
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "description": "The property to sort the results by. created_at means when the cache was created. last_accessed_at means when the cache was last accessed. size_in_bytes is the size of the cache in bytes.
The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "actions_caches": [ { "id": 505, "ref": "refs/heads/main", "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", "last_accessed_at": "2019-01-24T22:45:36.000Z", "created_at": "2019-01-24T22:45:36.000Z", "size_in_bytes": 1024 } ] }, "schema": { "title": "Repository actions caches", "description": "Repository actions caches", "type": "object", "properties": { "total_count": { "description": "Total number of caches", "type": "integer", "examples": [ 2 ] }, "actions_caches": { "description": "Array of caches", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 2 ] }, "ref": { "type": "string", "examples": [ "refs/heads/main" ] }, "key": { "type": "string", "examples": [ "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b" ] }, "version": { "type": "string", "examples": [ "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0" ] }, "last_accessed_at": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "size_in_bytes": { "type": "integer", "examples": [ 1024 ] } } } } }, "required": [ "total_count", "actions_caches" ] } } } ], "previews": [], "descriptionHTML": "Lists the GitHub Actions caches for a repository.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/caches", "title": "Delete GitHub Actions caches for a repository (using a cache key)", "category": "actions", "subcategory": "cache", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "description": "A key for identifying the cache.
", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ref", "description": "The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
Response
", "example": { "total_count": 1, "actions_caches": [ { "id": 505, "ref": "refs/heads/main", "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", "last_accessed_at": "2019-01-24T22:45:36.000Z", "created_at": "2019-01-24T22:45:36.000Z", "size_in_bytes": 1024 } ] }, "schema": { "title": "Repository actions caches", "description": "Repository actions caches", "type": "object", "properties": { "total_count": { "description": "Total number of caches", "type": "integer", "examples": [ 2 ] }, "actions_caches": { "description": "Array of caches", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 2 ] }, "ref": { "type": "string", "examples": [ "refs/heads/main" ] }, "key": { "type": "string", "examples": [ "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b" ] }, "version": { "type": "string", "examples": [ "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0" ] }, "last_accessed_at": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "size_in_bytes": { "type": "integer", "examples": [ 1024 ] } } } } }, "required": [ "total_count", "actions_caches" ] } } } ], "previews": [], "descriptionHTML": "Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
GitHub Apps must have the actions:write permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/caches/{cache_id}", "title": "Delete a GitHub Actions cache for a repository (using a cache ID)", "category": "actions", "subcategory": "cache", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cache_id", "description": "The unique identifier of the GitHub Actions cache.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "cache_id": "CACHE_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a GitHub Actions cache for a repository, using a cache ID.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
GitHub Apps must have the actions:write permission to use this endpoint.
No Content
" } ] } ], "oidc": [ { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/oidc/customization/issuer", "title": "Set the GitHub Actions OIDC custom issuer policy for an enterprise", "category": "actions", "subcategory": "oidc", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "boolean", "name": "include_enterprise_slug", "in": "body", "description": "Whether the enterprise customer requested a custom issuer URL.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "include_enterprise_slug": true }, "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Sets the GitHub Actions OpenID Connect (OIDC) custom issuer policy for an enterprise.\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.\nGitHub Apps must have the enterprise_administration:write permission to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/oidc/customization/sub", "title": "Get the customization template for an OIDC subject claim for an organization", "category": "actions", "subcategory": "oidc", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "A JSON serialized template for OIDC subject claim customization
", "example": { "include_claim_keys": [ "repo", "context" ] }, "schema": { "title": "Actions OIDC Subject customization", "description": "Actions OIDC Subject customization", "type": "object", "properties": { "include_claim_keys": { "type": "array", "items": { "type": "string" } } }, "required": [ "include_claim_keys" ] } } } ], "previews": [], "descriptionHTML": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\nYou must authenticate using an access token with the read:org scope to use this endpoint.\nGitHub Apps must have the organization_administration:write permission to use this endpoint.
A JSON serialized template for OIDC subject claim customization
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/oidc/customization/sub", "title": "Set the customization template for an OIDC subject claim for an organization", "category": "actions", "subcategory": "oidc", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of strings", "name": "include_claim_keys", "in": "body", "description": "", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "include_claim_keys": [ "repo", "context" ] }, "parameters": { "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Empty response
", "example": null, "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false } } } ], "previews": [], "descriptionHTML": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\nYou must authenticate using an access token with the write:org scope to use this endpoint.\nGitHub Apps must have the admin:org permission to use this endpoint.
Empty response
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub", "title": "Get the opt-out flag of an OIDC subject claim customization for a repository", "category": "actions", "subcategory": "oidc", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Status response
", "example": { "use_default": false }, "schema": { "title": "The json payload enables/disables the use of sub claim customization", "description": "OIDC Customer Subject", "type": "object", "properties": { "use_default": { "type": "boolean" } }, "required": [ "use_default" ] } } } ], "previews": [], "descriptionHTML": "Gets the opt-out flag of a GitHub Actions OpenID Connect (OIDC) subject claim customization for a repository.\nYou must authenticate using an access token with the repo scope to use this\nendpoint. GitHub Apps must have the organization_administration:read permission to use this endpoint.
Status response
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub", "title": "Set the opt-in flag of an OIDC subject claim customization for a repository", "category": "actions", "subcategory": "oidc", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "boolean", "name": "use_default", "in": "body", "description": "", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "use_default": false }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "description": "Empty response
" } } ], "previews": [], "descriptionHTML": "Sets the opt-in or opt-out flag of a GitHub Actions OpenID Connect (OIDC) subject claim customization for a repository.\nYou must authenticate using an access token with the repo scope to use this\nendpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Empty response
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "permissions": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/permissions", "title": "Get GitHub Actions permissions for an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "enabled_organizations": "all", "allowed_actions": "selected", "selected_actions_url": "https://api.github.com/enterprises/2/actions/permissions/selected-actions" }, "schema": { "type": "object", "properties": { "enabled_organizations": { "type": "string", "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.", "enum": [ "all", "none", "selected" ] }, "selected_organizations_url": { "type": "string", "description": "The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`." }, "allowed_actions": { "type": "string", "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", "enum": [ "all", "local_only", "selected" ] }, "selected_actions_url": { "type": "string", "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." } }, "required": [ "enabled_organizations" ] } } } ], "previews": [], "descriptionHTML": "Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/permissions", "title": "Set GitHub Actions permissions for an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "enabled_organizations", "in": "body", "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.
", "isRequired": true, "enum": [ "all", "none", "selected" ] }, { "type": "string", "name": "allowed_actions", "in": "body", "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.
", "enum": [ "all", "local_only", "selected" ] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_organizations": "all", "allowed_actions": "selected" }, "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", "title": "List selected organizations enabled for GitHub Actions in an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "organizations": [ { "login": "octocat", "id": 161335, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "url": "https://api.github.com/orgs/octo-org", "repos_url": "https://api.github.com/orgs/octo-org/repos", "events_url": "https://api.github.com/orgs/octo-org/events", "hooks_url": "https://api.github.com/orgs/octo-org/hooks", "issues_url": "https://api.github.com/orgs/octo-org/issues", "members_url": "https://api.github.com/orgs/octo-org/members{/member}", "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" } ] }, "schema": { "type": "object", "properties": { "total_count": { "type": "number" }, "organizations": { "type": "array", "items": { "title": "Organization Simple", "description": "Organization Simple", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] } } }, "required": [ "total_count", "organizations" ] } } } ], "previews": [], "descriptionHTML": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", "title": "Set selected organizations enabled for GitHub Actions in an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of integers", "name": "selected_organization_ids", "in": "body", "description": "List of organization IDs to enable for GitHub Actions.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_organization_ids": [ 32, 91 ] }, "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", "title": "Enable a selected organization for GitHub Actions in an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org_id", "description": "The unique identifier of the organization.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "org_id": "ORG_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", "title": "Disable a selected organization for GitHub Actions in an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org_id", "description": "The unique identifier of the organization.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "org_id": "ORG_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions", "title": "Get allowed actions and reusable workflows for an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "github_owned_allowed": true, "verified_allowed": false, "patterns_allowed": [ "monalisa/octocat@*", "docker/*" ] }, "schema": { "type": "object", "properties": { "github_owned_allowed": { "type": "boolean", "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, "verified_allowed": { "type": "boolean", "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, "patterns_allowed": { "type": "array", "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", "items": { "type": "string" } } } } } } ], "previews": [], "descriptionHTML": "Gets the selected actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions", "title": "Set allowed actions and reusable workflows for an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "boolean", "name": "github_owned_allowed", "in": "body", "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.
Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
Response
" } } ], "previews": [], "descriptionHTML": "Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/permissions/workflow", "title": "Get default workflow permissions for an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Give read-only permission, and allow approving PRs.
", "example": { "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true }, "schema": { "type": "object", "properties": { "default_workflow_permissions": { "type": "string", "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", "enum": [ "read", "write" ] }, "can_approve_pull_request_reviews": { "type": "boolean", "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." } }, "required": [ "default_workflow_permissions", "can_approve_pull_request_reviews" ] } } } ], "previews": [], "descriptionHTML": "Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.\nGitHub Apps must have the enterprise_administration:write permission to use this endpoint.
Success response
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/permissions/workflow", "title": "Set default workflow permissions for an enterprise", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "default_workflow_permissions", "in": "body", "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
", "enum": [ "read", "write" ] }, { "type": "boolean", "name": "can_approve_pull_request_reviews", "in": "body", "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Give read-only permission, and allow approving PRs.", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true }, "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "204", "description": "Success response
" } } ], "previews": [], "descriptionHTML": "Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.\nGitHub Apps must have the enterprise_administration:write permission to use this endpoint.
Success response
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/permissions", "title": "Get GitHub Actions permissions for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "enabled_repositories": "all", "allowed_actions": "selected", "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" }, "schema": { "type": "object", "properties": { "enabled_repositories": { "type": "string", "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", "enum": [ "all", "none", "selected" ] }, "selected_repositories_url": { "type": "string", "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." }, "allowed_actions": { "type": "string", "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", "enum": [ "all", "local_only", "selected" ] }, "selected_actions_url": { "type": "string", "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." } }, "required": [ "enabled_repositories" ] } } } ], "previews": [], "descriptionHTML": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/permissions", "title": "Set GitHub Actions permissions for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "enabled_repositories", "in": "body", "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.
", "isRequired": true, "enum": [ "all", "none", "selected" ] }, { "type": "string", "name": "allowed_actions", "in": "body", "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.
", "enum": [ "all", "local_only", "selected" ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_repositories": "all", "allowed_actions": "selected" }, "parameters": { "org": "ORG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions and reusable workflows, then you cannot override them for the organization.
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/permissions/repositories", "title": "List selected repositories enabled for GitHub Actions in an organization", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ] }, "schema": { "type": "object", "required": [ "total_count", "repositories" ], "properties": { "total_count": { "type": "number" }, "repositories": { "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/permissions/repositories", "title": "Set selected repositories enabled for GitHub Actions in an organization", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of integers", "name": "selected_repository_ids", "in": "body", "description": "List of repository IDs to enable for GitHub Actions.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ 32, 42 ] }, "parameters": { "org": "ORG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", "title": "Enable a selected repository for GitHub Actions in an organization", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "description": "The unique identifier of the repository.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", "title": "Disable a selected repository for GitHub Actions in an organization", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "description": "The unique identifier of the repository.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/permissions/selected-actions", "title": "Get allowed actions and reusable workflows for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "github_owned_allowed": true, "verified_allowed": false, "patterns_allowed": [ "monalisa/octocat@*", "docker/*" ] }, "schema": { "type": "object", "properties": { "github_owned_allowed": { "type": "boolean", "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, "verified_allowed": { "type": "boolean", "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, "patterns_allowed": { "type": "array", "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", "items": { "type": "string" } } } } } } ], "previews": [], "descriptionHTML": "Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"\"
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/permissions/selected-actions", "title": "Set allowed actions and reusable workflows for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "boolean", "name": "github_owned_allowed", "in": "body", "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.
Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
Response
" } } ], "previews": [], "descriptionHTML": "Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
If the organization belongs to an enterprise that has selected actions and reusable workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and reusable workflows settings.
To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/permissions/workflow", "title": "Get default workflow permissions for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Give read-only permission, and allow approving PRs.
", "example": { "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true }, "schema": { "type": "object", "properties": { "default_workflow_permissions": { "type": "string", "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", "enum": [ "read", "write" ] }, "can_approve_pull_request_reviews": { "type": "boolean", "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." } }, "required": [ "default_workflow_permissions", "can_approve_pull_request_reviews" ] } } } ], "previews": [], "descriptionHTML": "Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/permissions/workflow", "title": "Set default workflow permissions for an organization", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "default_workflow_permissions", "in": "body", "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
", "enum": [ "read", "write" ] }, { "type": "boolean", "name": "can_approve_pull_request_reviews", "in": "body", "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Give read-only permission, and allow approving PRs.", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true }, "parameters": { "org": "ORG" } }, "response": { "statusCode": "204", "description": "Success response
" } } ], "previews": [], "descriptionHTML": "Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Success response
" }, { "httpStatusCode": "409", "description": "Conflict response when changing a setting is prevented by the owning enterprise
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/permissions", "title": "Get GitHub Actions permissions for a repository", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "enabled": true, "allowed_actions": "selected", "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" }, "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether GitHub Actions is enabled on the repository." }, "allowed_actions": { "type": "string", "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", "enum": [ "all", "local_only", "selected" ] }, "selected_actions_url": { "type": "string", "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." } }, "required": [ "enabled" ] } } } ], "previews": [], "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/permissions", "title": "Set GitHub Actions permissions for a repository", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "boolean", "name": "enabled", "in": "body", "description": "Whether GitHub Actions is enabled on the repository.
", "isRequired": true }, { "type": "string", "name": "allowed_actions", "in": "body", "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.
", "enum": [ "all", "local_only", "selected" ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled": true, "allowed_actions": "selected" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.
\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions and reusable workflows, then you cannot override them for the repository.
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/permissions/access", "title": "Get the level of access for workflows outside of the repository", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "access_level": "organization" }, "schema": { "type": "object", "properties": { "access_level": { "type": "string", "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. `none` means access is only possible from workflows in this repository.", "enum": [ "none", "organization", "enterprise" ] } }, "required": [ "access_level" ] } } } ], "previews": [], "descriptionHTML": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"Managing GitHub Actions settings for a repository.\"
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the\nrepository administration permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/permissions/access", "title": "Set the level of access for workflows outside of the repository", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "access_level", "in": "body", "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. none means access is only possible from workflows in this repository.
Response
" } } ], "previews": [], "descriptionHTML": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"Managing GitHub Actions settings for a repository.\"
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the\nrepository administration permission to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", "title": "Get allowed actions and reusable workflows for a repository", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "github_owned_allowed": true, "verified_allowed": false, "patterns_allowed": [ "monalisa/octocat@*", "docker/*" ] }, "schema": { "type": "object", "properties": { "github_owned_allowed": { "type": "boolean", "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, "verified_allowed": { "type": "boolean", "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, "patterns_allowed": { "type": "array", "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", "items": { "type": "string" } } } } } } ], "previews": [], "descriptionHTML": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", "title": "Set allowed actions and reusable workflows for a repository", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "boolean", "name": "github_owned_allowed", "in": "body", "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.
Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
Response
" } } ], "previews": [], "descriptionHTML": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
If the repository belongs to an organization or enterprise that has selected actions and reusable workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and reusable workflows settings.
To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", "title": "Get default workflow permissions for a repository", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Give read-only permission, and allow approving PRs.
", "example": { "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true }, "schema": { "type": "object", "properties": { "default_workflow_permissions": { "type": "string", "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", "enum": [ "read", "write" ] }, "can_approve_pull_request_reviews": { "type": "boolean", "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." } }, "required": [ "default_workflow_permissions", "can_approve_pull_request_reviews" ] } } } ], "previews": [], "descriptionHTML": "Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the repository administration permission to use this API.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", "title": "Set default workflow permissions for a repository", "category": "actions", "subcategory": "permissions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "default_workflow_permissions", "in": "body", "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
", "enum": [ "read", "write" ] }, { "type": "boolean", "name": "can_approve_pull_request_reviews", "in": "body", "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Give read-only permission, and allow approving PRs.", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Success response
" } } ], "previews": [], "descriptionHTML": "Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the repository administration permission to use this API.
Success response
" }, { "httpStatusCode": "409", "description": "Conflict response when changing a setting is prevented by the owning organization or enterprise
" } ] } ], "secrets": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/secrets", "title": "List organization secrets", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 3, "secrets": [ { "name": "GIST_ID", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "private" }, { "name": "DEPLOY_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "all" }, { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" } ] }, "schema": { "type": "object", "required": [ "total_count", "secrets" ], "properties": { "total_count": { "type": "integer" }, "secrets": { "type": "array", "items": { "title": "Actions Secret for an Organization", "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "type": "string", "examples": [ "SECRET_TOKEN" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "visibility": { "description": "Visibility of a secret", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/org/secrets/my_secret/repositories" ] } }, "required": [ "name", "created_at", "updated_at", "visibility" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/secrets/public-key", "title": "Get an organization public key", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" }, "schema": { "title": "ActionsPublicKey", "description": "The public key used for setting Actions Secrets.", "type": "object", "properties": { "key_id": { "description": "The identifier for the key.", "type": "string", "examples": [ "1234567" ] }, "key": { "description": "The Base64 encoded public key.", "type": "string", "examples": [ "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" ] }, "id": { "type": "integer", "examples": [ 2 ] }, "url": { "type": "string", "examples": [ "https://api.github.com/user/keys/2" ] }, "title": { "type": "string", "examples": [ "ssh-rsa AAAAB3NzaC1yc2EAAA" ] }, "created_at": { "type": "string", "examples": [ "2011-01-26T19:01:12Z" ] } }, "required": [ "key_id", "key" ] } } } ], "previews": [], "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", "title": "Get an organization secret", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" }, "schema": { "title": "Actions Secret for an Organization", "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "type": "string", "examples": [ "SECRET_TOKEN" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "visibility": { "description": "Visibility of a secret", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/org/secrets/my_secret/repositories" ] } }, "required": [ "name", "created_at", "updated_at", "visibility" ] } } } ], "previews": [], "descriptionHTML": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", "title": "Create or update an organization secret", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "encrypted_value", "in": "body", "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.
" }, { "type": "string", "name": "key_id", "in": "body", "description": "ID of the key you used to encrypt the secret.
" }, { "type": "string", "name": "visibility", "in": "body", "description": "Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Response when creating a secret
", "example": null, "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false } } }, { "key": "204", "request": { "contentType": "application/json", "description": "Example 2: Status Code 204", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ 1296269, 1296280 ] }, "parameters": { "org": "ORG", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response when updating a secret
" } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Response when creating a secret
" }, { "httpStatusCode": "204", "description": "Response when updating a secret
" } ], "descriptionHTML": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to\nuse this endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the tweetsodium library.
\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\nThe organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", "title": "List selected repositories for an organization secret", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } ] }, "schema": { "type": "object", "required": [ "total_count", "repositories" ], "properties": { "total_count": { "type": "integer" }, "repositories": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", "title": "Set selected repositories for an organization secret", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of integers", "name": "selected_repository_ids", "in": "body", "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.
Response
" } } ], "previews": [], "descriptionHTML": "Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", "title": "Add selected repository to an organization secret", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "No Content when repository was added to the selected list
" } } ], "previews": [], "descriptionHTML": "Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
No Content when repository was added to the selected list
" }, { "httpStatusCode": "409", "description": "Conflict when visibility type is not set to selected
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", "title": "Remove selected repository from an organization secret", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "Response when repository was removed from the selected list
" } } ], "previews": [], "descriptionHTML": "Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
Response when repository was removed from the selected list
" }, { "httpStatusCode": "409", "description": "Conflict when visibility type not set to selected
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/secrets", "title": "List repository secrets", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "secrets": [ { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" }, { "name": "GIST_ID", "created_at": "2020-01-10T10:59:22Z", "updated_at": "2020-01-11T11:59:22Z" } ] }, "schema": { "type": "object", "required": [ "total_count", "secrets" ], "properties": { "total_count": { "type": "integer" }, "secrets": { "type": "array", "items": { "title": "Actions Secret", "description": "Set secrets for GitHub Actions.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "type": "string", "examples": [ "SECRET_TOKEN" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "created_at", "updated_at" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/secrets/public-key", "title": "Get a repository public key", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" }, "schema": { "title": "ActionsPublicKey", "description": "The public key used for setting Actions Secrets.", "type": "object", "properties": { "key_id": { "description": "The identifier for the key.", "type": "string", "examples": [ "1234567" ] }, "key": { "description": "The Base64 encoded public key.", "type": "string", "examples": [ "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" ] }, "id": { "type": "integer", "examples": [ 2 ] }, "url": { "type": "string", "examples": [ "https://api.github.com/user/keys/2" ] }, "title": { "type": "string", "examples": [ "ssh-rsa AAAAB3NzaC1yc2EAAA" ] }, "created_at": { "type": "string", "examples": [ "2011-01-26T19:01:12Z" ] } }, "required": [ "key_id", "key" ] } } } ], "previews": [], "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", "title": "Get a repository secret", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" }, "schema": { "title": "Actions Secret", "description": "Set secrets for GitHub Actions.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "type": "string", "examples": [ "SECRET_TOKEN" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", "title": "Create or update a repository secret", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "encrypted_value", "in": "body", "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
" }, { "type": "string", "name": "key_id", "in": "body", "description": "ID of the key you used to encrypt the secret.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" }, "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response when creating a secret
", "example": null, "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false } } }, { "key": "204", "request": { "contentType": "application/json", "description": "Example 2: Status Code 204", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" }, "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response when updating a secret
" } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Response when creating a secret
" }, { "httpStatusCode": "204", "description": "Response when updating a secret
" } ], "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the tweetsodium library.
\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\nThe account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets", "title": "List environment secrets", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "repository_id", "description": "The unique identifier of the repository.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "environment_name", "in": "path", "required": true, "description": "The name of the environment.
", "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", "environment_name": "ENVIRONMENT_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "secrets": [ { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" }, { "name": "GIST_ID", "created_at": "2020-01-10T10:59:22Z", "updated_at": "2020-01-11T11:59:22Z" } ] }, "schema": { "type": "object", "required": [ "total_count", "secrets" ], "properties": { "total_count": { "type": "integer" }, "secrets": { "type": "array", "items": { "title": "Actions Secret", "description": "Set secrets for GitHub Actions.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "type": "string", "examples": [ "SECRET_TOKEN" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "created_at", "updated_at" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key", "title": "Get an environment public key", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "repository_id", "description": "The unique identifier of the repository.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "environment_name", "in": "path", "required": true, "description": "The name of the environment.
", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", "environment_name": "ENVIRONMENT_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" }, "schema": { "title": "ActionsPublicKey", "description": "The public key used for setting Actions Secrets.", "type": "object", "properties": { "key_id": { "description": "The identifier for the key.", "type": "string", "examples": [ "1234567" ] }, "key": { "description": "The Base64 encoded public key.", "type": "string", "examples": [ "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" ] }, "id": { "type": "integer", "examples": [ 2 ] }, "url": { "type": "string", "examples": [ "https://api.github.com/user/keys/2" ] }, "title": { "type": "string", "examples": [ "ssh-rsa AAAAB3NzaC1yc2EAAA" ] }, "created_at": { "type": "string", "examples": [ "2011-01-26T19:01:12Z" ] } }, "required": [ "key_id", "key" ] } } } ], "previews": [], "descriptionHTML": "Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "title": "Get an environment secret", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "repository_id", "description": "The unique identifier of the repository.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "environment_name", "in": "path", "required": true, "description": "The name of the environment.
", "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", "environment_name": "ENVIRONMENT_NAME", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" }, "schema": { "title": "Actions Secret", "description": "Set secrets for GitHub Actions.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "type": "string", "examples": [ "SECRET_TOKEN" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "title": "Create or update an environment secret", "category": "actions", "subcategory": "secrets", "parameters": [ { "name": "repository_id", "description": "The unique identifier of the repository.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "environment_name", "in": "path", "required": true, "description": "The name of the environment.
", "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "encrypted_value", "in": "body", "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.
", "isRequired": true }, { "type": "string", "name": "key_id", "in": "body", "description": "ID of the key you used to encrypt the secret.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" }, "parameters": { "repository_id": "REPOSITORY_ID", "environment_name": "ENVIRONMENT_NAME", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response when creating a secret
", "example": null, "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false } } }, { "key": "204", "request": { "contentType": "application/json", "description": "Example 2: Status Code 204", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" }, "parameters": { "repository_id": "REPOSITORY_ID", "environment_name": "ENVIRONMENT_NAME", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response when updating a secret
" } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Response when creating a secret
" }, { "httpStatusCode": "204", "description": "Response when updating a secret
" } ], "descriptionHTML": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the tweetsodium library.
\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\nThe unique identifier of the repository.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "environment_name", "in": "path", "required": true, "description": "The name of the environment.
", "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", "environment_name": "ENVIRONMENT_NAME", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Default response
" } } ], "previews": [], "descriptionHTML": "Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Default response
" } ] } ], "self-hosted-runner-groups": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runner-groups", "title": "List self-hosted runner groups for an enterprise", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "visible_to_organization", "description": "Only return runner groups that are allowed to be used by this organization.
", "in": "query", "required": false, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 3, "runner_groups": [ { "id": 1, "name": "Default", "visibility": "all", "default": true, "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners", "allows_public_repositories": false, "restricted_to_workflows": false, "selected_workflows": [], "workflow_restrictions_read_only": false }, { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations", "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners", "allows_public_repositories": true, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }, { "id": 3, "name": "expensive-hardware", "visibility": "private", "default": false, "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners", "allows_public_repositories": true, "restricted_to_workflows": false, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false } ] }, "schema": { "type": "object", "properties": { "total_count": { "type": "number" }, "runner_groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "visibility": { "type": "string" }, "default": { "type": "boolean" }, "selected_organizations_url": { "type": "string" }, "runners_url": { "type": "string" }, "allows_public_repositories": { "type": "boolean" }, "workflow_restrictions_read_only": { "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "examples": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } } }, "required": [ "id", "name", "visibility", "allows_public_repositories", "default", "runners_url" ] } } }, "required": [ "total_count", "runner_groups" ] } } } ], "previews": [], "descriptionHTML": "Lists all self-hosted runner groups for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/enterprises/{enterprise}/actions/runner-groups", "title": "Create a self-hosted runner group for an enterprise", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "Name of the runner group.
", "isRequired": true }, { "type": "string", "name": "visibility", "in": "body", "description": "Visibility of a runner group. You can select all organizations or select individual organization.
", "enum": [ "selected", "all" ] }, { "type": "array of integers", "name": "selected_organization_ids", "in": "body", "description": "List of organization IDs that can access the runner group.
" }, { "type": "array of integers", "name": "runners", "in": "body", "description": "List of runner IDs to add to the runner group.
" }, { "type": "boolean", "name": "allows_public_repositories", "in": "body", "description": "Whether the runner group can be used by public repositories.
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
Response
", "example": { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", "allows_public_repositories": false, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }, "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "visibility": { "type": "string" }, "default": { "type": "boolean" }, "selected_organizations_url": { "type": "string" }, "runners_url": { "type": "string" }, "allows_public_repositories": { "type": "boolean" }, "workflow_restrictions_read_only": { "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "examples": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } } }, "required": [ "id", "name", "visibility", "allows_public_repositories", "default", "runners_url" ] } } } ], "previews": [], "descriptionHTML": "Creates a new self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", "title": "Get a self-hosted runner group for an enterprise", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", "allows_public_repositories": false, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }, "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "visibility": { "type": "string" }, "default": { "type": "boolean" }, "selected_organizations_url": { "type": "string" }, "runners_url": { "type": "string" }, "allows_public_repositories": { "type": "boolean" }, "workflow_restrictions_read_only": { "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "examples": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } } }, "required": [ "id", "name", "visibility", "allows_public_repositories", "default", "runners_url" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", "title": "Update a self-hosted runner group for an enterprise", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "Name of the runner group.
" }, { "type": "string", "name": "visibility", "in": "body", "description": "Visibility of a runner group. You can select all organizations or select individual organizations.
", "enum": [ "selected", "all" ], "default": "all" }, { "type": "boolean", "name": "allows_public_repositories", "in": "body", "description": "Whether the runner group can be used by public repositories.
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
Response
", "example": { "id": 2, "name": "Expensive hardware runners", "visibility": "selected", "default": false, "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", "allows_public_repositories": true, "restricted_to_workflows": false, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }, "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "visibility": { "type": "string" }, "default": { "type": "boolean" }, "selected_organizations_url": { "type": "string" }, "runners_url": { "type": "string" }, "allows_public_repositories": { "type": "boolean" }, "workflow_restrictions_read_only": { "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "examples": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } } }, "required": [ "id", "name", "visibility", "allows_public_repositories", "default", "runners_url" ] } } } ], "previews": [], "descriptionHTML": "Updates the name and visibility of a self-hosted runner group in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", "title": "Delete a self-hosted runner group from an enterprise", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", "title": "List organization access to a self-hosted runner group in an enterprise", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "organizations": [ { "login": "octocat", "id": 161335, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "url": "https://api.github.com/orgs/octo-org", "repos_url": "https://api.github.com/orgs/octo-org/repos", "events_url": "https://api.github.com/orgs/octo-org/events", "hooks_url": "https://api.github.com/orgs/octo-org/hooks", "issues_url": "https://api.github.com/orgs/octo-org/issues", "members_url": "https://api.github.com/orgs/octo-org/members{/member}", "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" } ] }, "schema": { "type": "object", "properties": { "total_count": { "type": "number" }, "organizations": { "type": "array", "items": { "title": "Organization Simple", "description": "Organization Simple", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] } } }, "required": [ "total_count", "organizations" ] } } } ], "previews": [], "descriptionHTML": "Lists the organizations with access to a self-hosted runner group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", "title": "Set organization access for a self-hosted runner group in an enterprise", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of integers", "name": "selected_organization_ids", "in": "body", "description": "List of organization IDs that can access the runner group.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_organization_ids": [ 32, 91 ] }, "parameters": { "enterprise": "ENTERPRISE", "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", "title": "Add organization access to a self-hosted runner group in an enterprise", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "org_id", "description": "The unique identifier of the organization.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "runner_group_id": "RUNNER_GROUP_ID", "org_id": "ORG_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", "title": "Remove organization access to a self-hosted runner group in an enterprise", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "org_id", "description": "The unique identifier of the organization.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "runner_group_id": "RUNNER_GROUP_ID", "org_id": "ORG_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", "title": "List self-hosted runners in a group for an enterprise", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "runners": [ { "id": 23, "name": "linux_runner", "os": "linux", "status": "online", "busy": true, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 11, "name": "Linux", "type": "read-only" } ] }, { "id": 24, "name": "mac_runner", "os": "macos", "status": "offline", "busy": false, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } ] }, "schema": { "type": "object", "properties": { "total_count": { "type": "number" }, "runners": { "type": "array", "items": { "title": "Self hosted runners", "description": "A self hosted runner", "type": "object", "properties": { "id": { "description": "The id of the runner.", "type": "integer", "examples": [ 5 ] }, "name": { "description": "The name of the runner.", "type": "string", "examples": [ "iMac" ] }, "os": { "description": "The Operating System of the runner.", "type": "string", "examples": [ "macos" ] }, "status": { "description": "The status of the runner.", "type": "string", "examples": [ "online" ] }, "busy": { "type": "boolean" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } }, "required": [ "id", "name", "os", "status", "busy", "labels" ] } } }, "required": [ "total_count", "runners" ] } } } ], "previews": [], "descriptionHTML": "Lists the self-hosted runners that are in a specific enterprise group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", "title": "Set self-hosted runners in a group for an enterprise", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of integers", "name": "runners", "in": "body", "description": "List of runner IDs to add to the runner group.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "runners": [ 9, 2 ] }, "parameters": { "enterprise": "ENTERPRISE", "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Replaces the list of self-hosted runners that are part of an enterprise runner group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "title": "Add a self-hosted runner to a group for an enterprise", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "runner_group_id": "RUNNER_GROUP_ID", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Adds a self-hosted runner to a runner group configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise\nscope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "title": "Remove a self-hosted runner from a group for an enterprise", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "runner_group_id": "RUNNER_GROUP_ID", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/runner-groups", "title": "List self-hosted runner groups for an organization", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "visible_to_repository", "description": "Only return runner groups that are allowed to be used by this repository.
", "in": "query", "required": false, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 3, "runner_groups": [ { "id": 1, "name": "Default", "visibility": "all", "default": true, "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": false, "selected_workflows": [], "workflow_restrictions_read_only": false }, { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "inherited": true, "allows_public_repositories": true, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": true }, { "id": 3, "name": "expensive-hardware", "visibility": "private", "default": false, "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": false, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false } ] }, "schema": { "type": "object", "required": [ "total_count", "runner_groups" ], "properties": { "total_count": { "type": "number" }, "runner_groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "visibility": { "type": "string" }, "default": { "type": "boolean" }, "selected_repositories_url": { "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", "type": "string" }, "runners_url": { "type": "string" }, "inherited": { "type": "boolean" }, "inherited_allows_public_repositories": { "type": "boolean" }, "allows_public_repositories": { "type": "boolean" }, "workflow_restrictions_read_only": { "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "examples": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } } }, "required": [ "id", "name", "visibility", "default", "runners_url", "inherited", "allows_public_repositories" ] } } } } } } ], "previews": [], "descriptionHTML": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nLists all self-hosted runner groups configured in an organization and inherited from an enterprise.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/actions/runner-groups", "title": "Create a self-hosted runner group for an organization", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "Name of the runner group.
", "isRequired": true }, { "type": "string", "name": "visibility", "in": "body", "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.
", "enum": [ "selected", "all", "private" ], "default": "all" }, { "type": "array of integers", "name": "selected_repository_ids", "in": "body", "description": "List of repository IDs that can access the runner group.
" }, { "type": "array of integers", "name": "runners", "in": "body", "description": "List of runner IDs to add to the runner group.
" }, { "type": "boolean", "name": "allows_public_repositories", "in": "body", "description": "Whether the runner group can be used by public repositories.
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
Response
", "example": { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }, "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "visibility": { "type": "string" }, "default": { "type": "boolean" }, "selected_repositories_url": { "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", "type": "string" }, "runners_url": { "type": "string" }, "inherited": { "type": "boolean" }, "inherited_allows_public_repositories": { "type": "boolean" }, "allows_public_repositories": { "type": "boolean" }, "workflow_restrictions_read_only": { "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "examples": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } } }, "required": [ "id", "name", "visibility", "default", "runners_url", "inherited", "allows_public_repositories" ] } } } ], "previews": [], "descriptionHTML": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"GitHub's products.\"
\nCreates a new self-hosted runner group for an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", "title": "Get a self-hosted runner group for an organization", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }, "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "visibility": { "type": "string" }, "default": { "type": "boolean" }, "selected_repositories_url": { "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", "type": "string" }, "runners_url": { "type": "string" }, "inherited": { "type": "boolean" }, "inherited_allows_public_repositories": { "type": "boolean" }, "allows_public_repositories": { "type": "boolean" }, "workflow_restrictions_read_only": { "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "examples": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } } }, "required": [ "id", "name", "visibility", "default", "runners_url", "inherited", "allows_public_repositories" ] } } } ], "previews": [], "descriptionHTML": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nGets a specific self-hosted runner group for an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", "title": "Update a self-hosted runner group for an organization", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "Name of the runner group.
", "isRequired": true }, { "type": "string", "name": "visibility", "in": "body", "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.
", "enum": [ "selected", "all", "private" ] }, { "type": "boolean", "name": "allows_public_repositories", "in": "body", "description": "Whether the runner group can be used by public repositories.
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
Response
", "example": { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }, "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "visibility": { "type": "string" }, "default": { "type": "boolean" }, "selected_repositories_url": { "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", "type": "string" }, "runners_url": { "type": "string" }, "inherited": { "type": "boolean" }, "inherited_allows_public_repositories": { "type": "boolean" }, "allows_public_repositories": { "type": "boolean" }, "workflow_restrictions_read_only": { "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "examples": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } } }, "required": [ "id", "name", "visibility", "default", "runners_url", "inherited", "allows_public_repositories" ] } } } ], "previews": [], "descriptionHTML": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nUpdates the name and visibility of a self-hosted runner group in an organization.
You must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", "title": "Delete a self-hosted runner group from an organization", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nDeletes a self-hosted runner group for an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", "title": "List repository access to a self-hosted runner group in an organization", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "organization": null, "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "delete_branch_on_merge": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "forks": 1, "open_issues": 1, "watchers": 1 } ] }, "schema": { "type": "object", "required": [ "total_count", "repositories" ], "properties": { "total_count": { "type": "number" }, "repositories": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } } } ], "previews": [], "descriptionHTML": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"GitHub's products.\"
\nLists the repositories with access to a self-hosted runner group configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", "title": "Set repository access for a self-hosted runner group in an organization", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of integers", "name": "selected_repository_ids", "in": "body", "description": "List of repository IDs that can access the runner group.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ 32, 91 ] }, "parameters": { "org": "ORG", "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nReplaces the list of repositories that have access to a self-hosted runner group configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", "title": "Add repository access to a self-hosted runner group in an organization", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "repository_id", "description": "The unique identifier of the repository.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "runner_group_id": "RUNNER_GROUP_ID", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nAdds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"
You must authenticate using an access token with the admin:org\nscope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", "title": "Remove repository access to a self-hosted runner group in an organization", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "repository_id", "description": "The unique identifier of the repository.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "runner_group_id": "RUNNER_GROUP_ID", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nRemoves a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"
You must authenticate using an access token with the admin:org scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", "title": "List self-hosted runners in a group for an organization", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "runners": [ { "id": 23, "name": "linux_runner", "os": "linux", "status": "online", "busy": true, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 11, "name": "Linux", "type": "read-only" } ] }, { "id": 24, "name": "mac_runner", "os": "macos", "status": "offline", "busy": false, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } ] }, "schema": { "type": "object", "required": [ "total_count", "runners" ], "properties": { "total_count": { "type": "number" }, "runners": { "type": "array", "items": { "title": "Self hosted runners", "description": "A self hosted runner", "type": "object", "properties": { "id": { "description": "The id of the runner.", "type": "integer", "examples": [ 5 ] }, "name": { "description": "The name of the runner.", "type": "string", "examples": [ "iMac" ] }, "os": { "description": "The Operating System of the runner.", "type": "string", "examples": [ "macos" ] }, "status": { "description": "The status of the runner.", "type": "string", "examples": [ "online" ] }, "busy": { "type": "boolean" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } }, "required": [ "id", "name", "os", "status", "busy", "labels" ] } } } } } } ], "previews": [], "descriptionHTML": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nLists self-hosted runners that are in a specific organization group.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", "title": "Set self-hosted runners in a group for an organization", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of integers", "name": "runners", "in": "body", "description": "List of runner IDs to add to the runner group.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "runners": [ 9, 2 ] }, "parameters": { "org": "ORG", "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nReplaces the list of self-hosted runners that are part of an organization runner group.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "title": "Add a self-hosted runner to a group for an organization", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "runner_group_id": "RUNNER_GROUP_ID", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nAdds a self-hosted runner to a runner group configured in an organization.
\nYou must authenticate using an access token with the admin:org\nscope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "title": "Remove a self-hosted runner from a group for an organization", "category": "actions", "subcategory": "self-hosted-runner-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "runner_group_id": "RUNNER_GROUP_ID", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nRemoves a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
No Content
" } ] } ], "self-hosted-runners": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runners", "title": "List self-hosted runners for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "runners": [ { "id": 23, "name": "linux_runner", "os": "linux", "status": "online", "busy": true, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 11, "name": "Linux", "type": "read-only" } ] }, { "id": 24, "name": "mac_runner", "os": "macos", "status": "offline", "busy": false, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } ] }, "schema": { "type": "object", "properties": { "total_count": { "type": "number" }, "runners": { "type": "array", "items": { "title": "Self hosted runners", "description": "A self hosted runner", "type": "object", "properties": { "id": { "description": "The id of the runner.", "type": "integer", "examples": [ 5 ] }, "name": { "description": "The name of the runner.", "type": "string", "examples": [ "iMac" ] }, "os": { "description": "The Operating System of the runner.", "type": "string", "examples": [ "macos" ] }, "status": { "description": "The status of the runner.", "type": "string", "examples": [ "online" ] }, "busy": { "type": "boolean" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } }, "required": [ "id", "name", "os", "status", "busy", "labels" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all self-hosted runners configured for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runners/downloads", "title": "List runner applications for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "os": "osx", "architecture": "x64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", "filename": "actions-runner-osx-x64-2.164.0.tar.gz" }, { "os": "linux", "architecture": "x64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", "filename": "actions-runner-linux-x64-2.164.0.tar.gz" }, { "os": "linux", "architecture": "arm", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", "filename": "actions-runner-linux-arm-2.164.0.tar.gz" }, { "os": "win", "architecture": "x64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", "filename": "actions-runner-win-x64-2.164.0.zip" }, { "os": "linux", "architecture": "arm64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" } ], "schema": { "type": "array", "items": { "title": "Runner Application", "description": "Runner Application", "type": "object", "properties": { "os": { "type": "string" }, "architecture": { "type": "string" }, "download_url": { "type": "string" }, "filename": { "type": "string" }, "temp_download_token": { "description": "A short lived bearer token used to download the runner, if needed.", "type": "string" }, "sha256_checksum": { "type": "string" } }, "required": [ "os", "architecture", "download_url", "filename" ] } } } } ], "previews": [], "descriptionHTML": "Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/enterprises/{enterprise}/actions/runners/registration-token", "title": "Create a registration token for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" }, "schema": { "title": "Authentication Token", "description": "Authentication Token", "type": "object", "properties": { "token": { "description": "The token used for authentication", "type": "string", "examples": [ "v1.1f699f1069f60xxx" ] }, "expires_at": { "description": "The time this token expires", "type": "string", "format": "date-time", "examples": [ "2016-07-11T22:14:10Z" ] }, "permissions": { "type": "object", "examples": [ { "issues": "read", "deployments": "write" } ] }, "repositories": { "description": "The repositories this token has access to", "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "single_file": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] } }, "required": [ "token", "expires_at" ] } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ], "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Example using registration token
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\nThe slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" }, "schema": { "title": "Authentication Token", "description": "Authentication Token", "type": "object", "properties": { "token": { "description": "The token used for authentication", "type": "string", "examples": [ "v1.1f699f1069f60xxx" ] }, "expires_at": { "description": "The time this token expires", "type": "string", "format": "date-time", "examples": [ "2016-07-11T22:14:10Z" ] }, "permissions": { "type": "object", "examples": [ { "issues": "read", "deployments": "write" } ] }, "repositories": { "description": "The repositories this token has access to", "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "single_file": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] } }, "required": [ "token", "expires_at" ] } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ], "descriptionHTML": "Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Example using remove token
\nTo remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nThe slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 23, "name": "MBP", "os": "macos", "status": "online", "busy": true, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "title": "Self hosted runners", "description": "A self hosted runner", "type": "object", "properties": { "id": { "description": "The id of the runner.", "type": "integer", "examples": [ 5 ] }, "name": { "description": "The name of the runner.", "type": "string", "examples": [ "iMac" ] }, "os": { "description": "The Operating System of the runner.", "type": "string", "examples": [ "macos" ] }, "status": { "description": "The status of the runner.", "type": "string", "examples": [ "online" ] }, "busy": { "type": "boolean" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } }, "required": [ "id", "name", "os", "status", "busy", "labels" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", "title": "Delete a self-hosted runner from an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", "title": "List labels for a self-hosted runner for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all labels for a self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", "title": "Add custom labels to a self-hosted runner for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of strings", "name": "labels", "in": "body", "description": "The names of the custom labels to add to the runner.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ "gpu", "accelerated" ] }, "parameters": { "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Add custom labels to a self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", "title": "Set custom labels for a self-hosted runner for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of strings", "name": "labels", "in": "body", "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ "gpu", "accelerated" ] }, "parameters": { "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", "title": "Remove all custom labels from a self-hosted runner for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 3, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Remove all custom labels from a self-hosted runner configured in an\nenterprise. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}", "title": "Remove a custom label from a self-hosted runner for an enterprise", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "name", "description": "The name of a self-hosted runner's custom label.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "runner_id": "RUNNER_ID", "name": "NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Remove a custom label from a self-hosted runner configured\nin an enterprise. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/runners", "title": "List self-hosted runners for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "runners": [ { "id": 23, "name": "linux_runner", "os": "linux", "status": "online", "busy": true, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 11, "name": "Linux", "type": "read-only" } ] }, { "id": 24, "name": "mac_runner", "os": "macos", "status": "offline", "busy": false, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } ] }, "schema": { "type": "object", "required": [ "total_count", "runners" ], "properties": { "total_count": { "type": "integer" }, "runners": { "type": "array", "items": { "title": "Self hosted runners", "description": "A self hosted runner", "type": "object", "properties": { "id": { "description": "The id of the runner.", "type": "integer", "examples": [ 5 ] }, "name": { "description": "The name of the runner.", "type": "string", "examples": [ "iMac" ] }, "os": { "description": "The Operating System of the runner.", "type": "string", "examples": [ "macos" ] }, "status": { "description": "The status of the runner.", "type": "string", "examples": [ "online" ] }, "busy": { "type": "boolean" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } }, "required": [ "id", "name", "os", "status", "busy", "labels" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/runners/downloads", "title": "List runner applications for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "os": "osx", "architecture": "x64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", "filename": "actions-runner-osx-x64-2.164.0.tar.gz" }, { "os": "linux", "architecture": "x64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", "filename": "actions-runner-linux-x64-2.164.0.tar.gz" }, { "os": "linux", "architecture": "arm", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", "filename": "actions-runner-linux-arm-2.164.0.tar.gz" }, { "os": "win", "architecture": "x64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", "filename": "actions-runner-win-x64-2.164.0.zip" }, { "os": "linux", "architecture": "arm64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" } ], "schema": { "type": "array", "items": { "title": "Runner Application", "description": "Runner Application", "type": "object", "properties": { "os": { "type": "string" }, "architecture": { "type": "string" }, "download_url": { "type": "string" }, "filename": { "type": "string" }, "temp_download_token": { "description": "A short lived bearer token used to download the runner, if needed.", "type": "string" }, "sha256_checksum": { "type": "string" } }, "required": [ "os", "architecture", "download_url", "filename" ] } } } } ], "previews": [], "descriptionHTML": "Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/actions/runners/registration-token", "title": "Create a registration token for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" }, "schema": { "title": "Authentication Token", "description": "Authentication Token", "type": "object", "properties": { "token": { "description": "The token used for authentication", "type": "string", "examples": [ "v1.1f699f1069f60xxx" ] }, "expires_at": { "description": "The time this token expires", "type": "string", "format": "date-time", "examples": [ "2016-07-11T22:14:10Z" ] }, "permissions": { "type": "object", "examples": [ { "issues": "read", "deployments": "write" } ] }, "repositories": { "description": "The repositories this token has access to", "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "single_file": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] } }, "required": [ "token", "expires_at" ] } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ], "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using registration token
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nThe organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" }, "schema": { "title": "Authentication Token", "description": "Authentication Token", "type": "object", "properties": { "token": { "description": "The token used for authentication", "type": "string", "examples": [ "v1.1f699f1069f60xxx" ] }, "expires_at": { "description": "The time this token expires", "type": "string", "format": "date-time", "examples": [ "2016-07-11T22:14:10Z" ] }, "permissions": { "type": "object", "examples": [ { "issues": "read", "deployments": "write" } ] }, "repositories": { "description": "The repositories this token has access to", "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "single_file": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] } }, "required": [ "token", "expires_at" ] } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ], "descriptionHTML": "Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using remove token
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nThe organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 23, "name": "MBP", "os": "macos", "status": "online", "busy": true, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "title": "Self hosted runners", "description": "A self hosted runner", "type": "object", "properties": { "id": { "description": "The id of the runner.", "type": "integer", "examples": [ 5 ] }, "name": { "description": "The name of the runner.", "type": "string", "examples": [ "iMac" ] }, "os": { "description": "The Operating System of the runner.", "type": "string", "examples": [ "macos" ] }, "status": { "description": "The status of the runner.", "type": "string", "examples": [ "online" ] }, "busy": { "type": "boolean" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } }, "required": [ "id", "name", "os", "status", "busy", "labels" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/actions/runners/{runner_id}", "title": "Delete a self-hosted runner from an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", "title": "List labels for a self-hosted runner for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", "title": "Add custom labels to a self-hosted runner for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of strings", "name": "labels", "in": "body", "description": "The names of the custom labels to add to the runner.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ "gpu", "accelerated" ] }, "parameters": { "org": "ORG", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", "title": "Set custom labels for a self-hosted runner for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of strings", "name": "labels", "in": "body", "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ "gpu", "accelerated" ] }, "parameters": { "org": "ORG", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels", "title": "Remove all custom labels from a self-hosted runner for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 3, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}", "title": "Remove a custom label from a self-hosted runner for an organization", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "name", "description": "The name of a self-hosted runner's custom label.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "runner_id": "RUNNER_ID", "name": "NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runners", "title": "List self-hosted runners for a repository", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "runners": [ { "id": 23, "name": "linux_runner", "os": "linux", "status": "online", "busy": true, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 11, "name": "Linux", "type": "read-only" } ] }, { "id": 24, "name": "mac_runner", "os": "macos", "status": "offline", "busy": false, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } ] }, "schema": { "type": "object", "required": [ "total_count", "runners" ], "properties": { "total_count": { "type": "integer" }, "runners": { "type": "array", "items": { "title": "Self hosted runners", "description": "A self hosted runner", "type": "object", "properties": { "id": { "description": "The id of the runner.", "type": "integer", "examples": [ 5 ] }, "name": { "description": "The name of the runner.", "type": "string", "examples": [ "iMac" ] }, "os": { "description": "The Operating System of the runner.", "type": "string", "examples": [ "macos" ] }, "status": { "description": "The status of the runner.", "type": "string", "examples": [ "online" ] }, "busy": { "type": "boolean" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } }, "required": [ "id", "name", "os", "status", "busy", "labels" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runners/downloads", "title": "List runner applications for a repository", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "os": "osx", "architecture": "x64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", "filename": "actions-runner-osx-x64-2.164.0.tar.gz" }, { "os": "linux", "architecture": "x64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", "filename": "actions-runner-linux-x64-2.164.0.tar.gz" }, { "os": "linux", "architecture": "arm", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", "filename": "actions-runner-linux-arm-2.164.0.tar.gz" }, { "os": "win", "architecture": "x64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", "filename": "actions-runner-win-x64-2.164.0.zip" }, { "os": "linux", "architecture": "arm64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" } ], "schema": { "type": "array", "items": { "title": "Runner Application", "description": "Runner Application", "type": "object", "properties": { "os": { "type": "string" }, "architecture": { "type": "string" }, "download_url": { "type": "string" }, "filename": { "type": "string" }, "temp_download_token": { "description": "A short lived bearer token used to download the runner, if needed.", "type": "string" }, "sha256_checksum": { "type": "string" } }, "required": [ "os", "architecture", "download_url", "filename" ] } } } } ], "previews": [], "descriptionHTML": "Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runners/registration-token", "title": "Create a registration token for a repository", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" }, "schema": { "title": "Authentication Token", "description": "Authentication Token", "type": "object", "properties": { "token": { "description": "The token used for authentication", "type": "string", "examples": [ "v1.1f699f1069f60xxx" ] }, "expires_at": { "description": "The time this token expires", "type": "string", "format": "date-time", "examples": [ "2016-07-11T22:14:10Z" ] }, "permissions": { "type": "object", "examples": [ { "issues": "read", "deployments": "write" } ] }, "repositories": { "description": "The repositories this token has access to", "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "single_file": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] } }, "required": [ "token", "expires_at" ] } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ], "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.
Example using registration token
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\nThe account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" }, "schema": { "title": "Authentication Token", "description": "Authentication Token", "type": "object", "properties": { "token": { "description": "The token used for authentication", "type": "string", "examples": [ "v1.1f699f1069f60xxx" ] }, "expires_at": { "description": "The time this token expires", "type": "string", "format": "date-time", "examples": [ "2016-07-11T22:14:10Z" ] }, "permissions": { "type": "object", "examples": [ { "issues": "read", "deployments": "write" } ] }, "repositories": { "description": "The repositories this token has access to", "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "single_file": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] } }, "required": [ "token", "expires_at" ] } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ], "descriptionHTML": "Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.
Example using remove token
\nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
\n./config.sh remove --token TOKEN\nThe account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 23, "name": "MBP", "os": "macos", "status": "online", "busy": true, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "title": "Self hosted runners", "description": "A self hosted runner", "type": "object", "properties": { "id": { "description": "The id of the runner.", "type": "integer", "examples": [ 5 ] }, "name": { "description": "The name of the runner.", "type": "string", "examples": [ "iMac" ] }, "os": { "description": "The Operating System of the runner.", "type": "string", "examples": [ "macos" ] }, "status": { "description": "The status of the runner.", "type": "string", "examples": [ "online" ] }, "busy": { "type": "boolean" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } }, "required": [ "id", "name", "os", "status", "busy", "labels" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", "title": "Delete a self-hosted runner from a repository", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo\nscope to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", "title": "List labels for a self-hosted runner for a repository", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", "title": "Add custom labels to a self-hosted runner for a repository", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of strings", "name": "labels", "in": "body", "description": "The names of the custom labels to add to the runner.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ "gpu", "accelerated" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", "title": "Set custom labels for a self-hosted runner for a repository", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of strings", "name": "labels", "in": "body", "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ "gpu", "accelerated" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", "title": "Remove all custom labels from a self-hosted runner for a repository", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 3, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}", "title": "Remove a custom label from a self-hosted runner for a repository", "category": "actions", "subcategory": "self-hosted-runners", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "name", "description": "The name of a self-hosted runner's custom label.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "runner_id": "RUNNER_ID", "name": "NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } } } } ], "previews": [], "descriptionHTML": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this\nendpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "workflow-jobs": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}", "title": "Get a job for a workflow run", "category": "actions", "subcategory": "workflow-jobs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "job_id", "description": "The unique identifier of the job.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "job_id": "JOB_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 399444496, "run_id": 29679449, "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", "completed_at": "2020-01-20T17:44:39Z", "name": "build", "steps": [ { "name": "Set up job", "status": "completed", "conclusion": "success", "number": 1, "started_at": "2020-01-20T09:42:40.000-08:00", "completed_at": "2020-01-20T09:42:41.000-08:00" }, { "name": "Run actions/checkout@v2", "status": "completed", "conclusion": "success", "number": 2, "started_at": "2020-01-20T09:42:41.000-08:00", "completed_at": "2020-01-20T09:42:45.000-08:00" }, { "name": "Set up Ruby", "status": "completed", "conclusion": "success", "number": 3, "started_at": "2020-01-20T09:42:45.000-08:00", "completed_at": "2020-01-20T09:42:45.000-08:00" }, { "name": "Run actions/cache@v3", "status": "completed", "conclusion": "success", "number": 4, "started_at": "2020-01-20T09:42:45.000-08:00", "completed_at": "2020-01-20T09:42:48.000-08:00" }, { "name": "Install Bundler", "status": "completed", "conclusion": "success", "number": 5, "started_at": "2020-01-20T09:42:48.000-08:00", "completed_at": "2020-01-20T09:42:52.000-08:00" }, { "name": "Install Gems", "status": "completed", "conclusion": "success", "number": 6, "started_at": "2020-01-20T09:42:52.000-08:00", "completed_at": "2020-01-20T09:42:53.000-08:00" }, { "name": "Run Tests", "status": "completed", "conclusion": "success", "number": 7, "started_at": "2020-01-20T09:42:53.000-08:00", "completed_at": "2020-01-20T09:42:59.000-08:00" }, { "name": "Deploy to Heroku", "status": "completed", "conclusion": "success", "number": 8, "started_at": "2020-01-20T09:42:59.000-08:00", "completed_at": "2020-01-20T09:44:39.000-08:00" }, { "name": "Post actions/cache@v3", "status": "completed", "conclusion": "success", "number": 16, "started_at": "2020-01-20T09:44:39.000-08:00", "completed_at": "2020-01-20T09:44:39.000-08:00" }, { "name": "Complete job", "status": "completed", "conclusion": "success", "number": 17, "started_at": "2020-01-20T09:44:39.000-08:00", "completed_at": "2020-01-20T09:44:39.000-08:00" } ], "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", "labels": [ "self-hosted", "foo", "bar" ], "runner_id": 1, "runner_name": "my runner", "runner_group_id": 2, "runner_group_name": "my runner group" }, "schema": { "title": "Job", "description": "Information of a job execution in a workflow run", "type": "object", "properties": { "id": { "description": "The id of the job.", "type": "integer", "examples": [ 21 ] }, "run_id": { "description": "The id of the associated workflow run.", "type": "integer", "examples": [ 5 ] }, "run_url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5" ] }, "run_attempt": { "type": "integer", "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6Q2hlY2tSdW40" ] }, "head_sha": { "description": "The SHA of the commit that is being run.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/jobs/21" ] }, "html_url": { "type": [ "string", "null" ], "examples": [ "https://github.com/github/hello-world/runs/4" ] }, "status": { "description": "The phase of the lifecycle that the job is currently in.", "type": "string", "enum": [ "queued", "in_progress", "completed" ], "examples": [ "queued" ] }, "conclusion": { "description": "The outcome of the job.", "type": [ "string", "null" ], "examples": [ "success" ] }, "started_at": { "description": "The time that the job started, in ISO 8601 format.", "format": "date-time", "type": "string", "examples": [ "2019-08-08T08:00:00-07:00" ] }, "completed_at": { "description": "The time that the job finished, in ISO 8601 format.", "format": "date-time", "type": [ "string", "null" ], "examples": [ "2019-08-08T08:00:00-07:00" ] }, "name": { "description": "The name of the job.", "type": "string", "examples": [ "test-coverage" ] }, "steps": { "description": "Steps in this job.", "type": "array", "items": { "type": "object", "required": [ "name", "status", "conclusion", "number" ], "properties": { "status": { "description": "The phase of the lifecycle that the job is currently in.", "type": "string", "enum": [ "queued", "in_progress", "completed" ], "examples": [ "queued" ] }, "conclusion": { "description": "The outcome of the job.", "type": [ "string", "null" ], "examples": [ "success" ] }, "name": { "description": "The name of the job.", "type": "string", "examples": [ "test-coverage" ] }, "number": { "type": "integer", "examples": [ 1 ] }, "started_at": { "description": "The time that the step started, in ISO 8601 format.", "format": "date-time", "type": [ "string", "null" ], "examples": [ "2019-08-08T08:00:00-07:00" ] }, "completed_at": { "description": "The time that the job finished, in ISO 8601 format.", "format": "date-time", "type": [ "string", "null" ], "examples": [ "2019-08-08T08:00:00-07:00" ] } } } }, "check_run_url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-runs/4" ] }, "labels": { "type": "array", "items": { "type": "string" }, "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", "examples": [ "self-hosted", "foo", "bar" ] }, "runner_id": { "type": [ "integer", "null" ], "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", "examples": [ 1 ] }, "runner_name": { "type": [ "string", "null" ], "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", "examples": [ "my runner" ] }, "runner_group_id": { "type": [ "integer", "null" ], "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", "examples": [ 2 ] }, "runner_group_name": { "type": [ "string", "null" ], "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", "examples": [ "my runner group" ] } }, "required": [ "id", "node_id", "run_id", "run_url", "head_sha", "name", "url", "html_url", "status", "conclusion", "started_at", "completed_at", "check_run_url", "labels", "runner_id", "runner_name", "runner_group_id", "runner_group_name" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", "title": "Download job logs for a workflow run", "category": "actions", "subcategory": "workflow-jobs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "job_id", "description": "The unique identifier of the job.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "job_id": "JOB_ID" } }, "response": { "statusCode": "302", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor Location: in the response header to find the URL for the download. Anyone with read access to the repository can\nuse this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must\nhave the actions:read permission to use this endpoint.
Found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs", "title": "List jobs for a workflow run attempt", "category": "actions", "subcategory": "workflow-jobs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "attempt_number", "description": "The attempt number of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID", "attempt_number": "ATTEMPT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "jobs": [ { "id": 399444496, "run_id": 29679449, "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", "completed_at": "2020-01-20T17:44:39Z", "name": "build", "steps": [ { "name": "Set up job", "status": "completed", "conclusion": "success", "number": 1, "started_at": "2020-01-20T09:42:40.000-08:00", "completed_at": "2020-01-20T09:42:41.000-08:00" }, { "name": "Run actions/checkout@v2", "status": "completed", "conclusion": "success", "number": 2, "started_at": "2020-01-20T09:42:41.000-08:00", "completed_at": "2020-01-20T09:42:45.000-08:00" }, { "name": "Set up Ruby", "status": "completed", "conclusion": "success", "number": 3, "started_at": "2020-01-20T09:42:45.000-08:00", "completed_at": "2020-01-20T09:42:45.000-08:00" }, { "name": "Run actions/cache@v3", "status": "completed", "conclusion": "success", "number": 4, "started_at": "2020-01-20T09:42:45.000-08:00", "completed_at": "2020-01-20T09:42:48.000-08:00" }, { "name": "Install Bundler", "status": "completed", "conclusion": "success", "number": 5, "started_at": "2020-01-20T09:42:48.000-08:00", "completed_at": "2020-01-20T09:42:52.000-08:00" }, { "name": "Install Gems", "status": "completed", "conclusion": "success", "number": 6, "started_at": "2020-01-20T09:42:52.000-08:00", "completed_at": "2020-01-20T09:42:53.000-08:00" }, { "name": "Run Tests", "status": "completed", "conclusion": "success", "number": 7, "started_at": "2020-01-20T09:42:53.000-08:00", "completed_at": "2020-01-20T09:42:59.000-08:00" }, { "name": "Deploy to Heroku", "status": "completed", "conclusion": "success", "number": 8, "started_at": "2020-01-20T09:42:59.000-08:00", "completed_at": "2020-01-20T09:44:39.000-08:00" }, { "name": "Post actions/cache@v3", "status": "completed", "conclusion": "success", "number": 16, "started_at": "2020-01-20T09:44:39.000-08:00", "completed_at": "2020-01-20T09:44:39.000-08:00" }, { "name": "Complete job", "status": "completed", "conclusion": "success", "number": 17, "started_at": "2020-01-20T09:44:39.000-08:00", "completed_at": "2020-01-20T09:44:39.000-08:00" } ], "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", "labels": [ "self-hosted", "foo", "bar" ], "runner_id": 1, "runner_name": "my runner", "runner_group_id": 2, "runner_group_name": "my runner group" } ] }, "schema": { "type": "object", "required": [ "total_count", "jobs" ], "properties": { "total_count": { "type": "integer" }, "jobs": { "type": "array", "items": { "title": "Job", "description": "Information of a job execution in a workflow run", "type": "object", "properties": { "id": { "description": "The id of the job.", "type": "integer", "examples": [ 21 ] }, "run_id": { "description": "The id of the associated workflow run.", "type": "integer", "examples": [ 5 ] }, "run_url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5" ] }, "run_attempt": { "type": "integer", "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6Q2hlY2tSdW40" ] }, "head_sha": { "description": "The SHA of the commit that is being run.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/jobs/21" ] }, "html_url": { "type": [ "string", "null" ], "examples": [ "https://github.com/github/hello-world/runs/4" ] }, "status": { "description": "The phase of the lifecycle that the job is currently in.", "type": "string", "enum": [ "queued", "in_progress", "completed" ], "examples": [ "queued" ] }, "conclusion": { "description": "The outcome of the job.", "type": [ "string", "null" ], "examples": [ "success" ] }, "started_at": { "description": "The time that the job started, in ISO 8601 format.", "format": "date-time", "type": "string", "examples": [ "2019-08-08T08:00:00-07:00" ] }, "completed_at": { "description": "The time that the job finished, in ISO 8601 format.", "format": "date-time", "type": [ "string", "null" ], "examples": [ "2019-08-08T08:00:00-07:00" ] }, "name": { "description": "The name of the job.", "type": "string", "examples": [ "test-coverage" ] }, "steps": { "description": "Steps in this job.", "type": "array", "items": { "type": "object", "required": [ "name", "status", "conclusion", "number" ], "properties": { "status": { "description": "The phase of the lifecycle that the job is currently in.", "type": "string", "enum": [ "queued", "in_progress", "completed" ], "examples": [ "queued" ] }, "conclusion": { "description": "The outcome of the job.", "type": [ "string", "null" ], "examples": [ "success" ] }, "name": { "description": "The name of the job.", "type": "string", "examples": [ "test-coverage" ] }, "number": { "type": "integer", "examples": [ 1 ] }, "started_at": { "description": "The time that the step started, in ISO 8601 format.", "format": "date-time", "type": [ "string", "null" ], "examples": [ "2019-08-08T08:00:00-07:00" ] }, "completed_at": { "description": "The time that the job finished, in ISO 8601 format.", "format": "date-time", "type": [ "string", "null" ], "examples": [ "2019-08-08T08:00:00-07:00" ] } } } }, "check_run_url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-runs/4" ] }, "labels": { "type": "array", "items": { "type": "string" }, "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", "examples": [ "self-hosted", "foo", "bar" ] }, "runner_id": { "type": [ "integer", "null" ], "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", "examples": [ 1 ] }, "runner_name": { "type": [ "string", "null" ], "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", "examples": [ "my runner" ] }, "runner_group_id": { "type": [ "integer", "null" ], "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", "examples": [ 2 ] }, "runner_group_name": { "type": [ "string", "null" ], "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", "examples": [ "my runner group" ] } }, "required": [ "id", "node_id", "run_id", "run_url", "head_sha", "name", "url", "html_url", "status", "conclusion", "started_at", "completed_at", "check_run_url", "labels", "runner_id", "runner_name", "runner_group_id", "runner_group_name" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", "title": "List jobs for a workflow run", "category": "actions", "subcategory": "workflow-jobs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "filter", "description": "Filters jobs by their completed_at timestamp. latest returns jobs from the most recent execution of the workflow run. all returns all jobs for a workflow run, including from old executions of the workflow run.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "jobs": [ { "id": 399444496, "run_id": 29679449, "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", "completed_at": "2020-01-20T17:44:39Z", "name": "build", "steps": [ { "name": "Set up job", "status": "completed", "conclusion": "success", "number": 1, "started_at": "2020-01-20T09:42:40.000-08:00", "completed_at": "2020-01-20T09:42:41.000-08:00" }, { "name": "Run actions/checkout@v2", "status": "completed", "conclusion": "success", "number": 2, "started_at": "2020-01-20T09:42:41.000-08:00", "completed_at": "2020-01-20T09:42:45.000-08:00" }, { "name": "Set up Ruby", "status": "completed", "conclusion": "success", "number": 3, "started_at": "2020-01-20T09:42:45.000-08:00", "completed_at": "2020-01-20T09:42:45.000-08:00" }, { "name": "Run actions/cache@v3", "status": "completed", "conclusion": "success", "number": 4, "started_at": "2020-01-20T09:42:45.000-08:00", "completed_at": "2020-01-20T09:42:48.000-08:00" }, { "name": "Install Bundler", "status": "completed", "conclusion": "success", "number": 5, "started_at": "2020-01-20T09:42:48.000-08:00", "completed_at": "2020-01-20T09:42:52.000-08:00" }, { "name": "Install Gems", "status": "completed", "conclusion": "success", "number": 6, "started_at": "2020-01-20T09:42:52.000-08:00", "completed_at": "2020-01-20T09:42:53.000-08:00" }, { "name": "Run Tests", "status": "completed", "conclusion": "success", "number": 7, "started_at": "2020-01-20T09:42:53.000-08:00", "completed_at": "2020-01-20T09:42:59.000-08:00" }, { "name": "Deploy to Heroku", "status": "completed", "conclusion": "success", "number": 8, "started_at": "2020-01-20T09:42:59.000-08:00", "completed_at": "2020-01-20T09:44:39.000-08:00" }, { "name": "Post actions/cache@v3", "status": "completed", "conclusion": "success", "number": 16, "started_at": "2020-01-20T09:44:39.000-08:00", "completed_at": "2020-01-20T09:44:39.000-08:00" }, { "name": "Complete job", "status": "completed", "conclusion": "success", "number": 17, "started_at": "2020-01-20T09:44:39.000-08:00", "completed_at": "2020-01-20T09:44:39.000-08:00" } ], "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", "labels": [ "self-hosted", "foo", "bar" ], "runner_id": 1, "runner_name": "my runner", "runner_group_id": 2, "runner_group_name": "my runner group" } ] }, "schema": { "type": "object", "required": [ "total_count", "jobs" ], "properties": { "total_count": { "type": "integer" }, "jobs": { "type": "array", "items": { "title": "Job", "description": "Information of a job execution in a workflow run", "type": "object", "properties": { "id": { "description": "The id of the job.", "type": "integer", "examples": [ 21 ] }, "run_id": { "description": "The id of the associated workflow run.", "type": "integer", "examples": [ 5 ] }, "run_url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5" ] }, "run_attempt": { "type": "integer", "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6Q2hlY2tSdW40" ] }, "head_sha": { "description": "The SHA of the commit that is being run.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/jobs/21" ] }, "html_url": { "type": [ "string", "null" ], "examples": [ "https://github.com/github/hello-world/runs/4" ] }, "status": { "description": "The phase of the lifecycle that the job is currently in.", "type": "string", "enum": [ "queued", "in_progress", "completed" ], "examples": [ "queued" ] }, "conclusion": { "description": "The outcome of the job.", "type": [ "string", "null" ], "examples": [ "success" ] }, "started_at": { "description": "The time that the job started, in ISO 8601 format.", "format": "date-time", "type": "string", "examples": [ "2019-08-08T08:00:00-07:00" ] }, "completed_at": { "description": "The time that the job finished, in ISO 8601 format.", "format": "date-time", "type": [ "string", "null" ], "examples": [ "2019-08-08T08:00:00-07:00" ] }, "name": { "description": "The name of the job.", "type": "string", "examples": [ "test-coverage" ] }, "steps": { "description": "Steps in this job.", "type": "array", "items": { "type": "object", "required": [ "name", "status", "conclusion", "number" ], "properties": { "status": { "description": "The phase of the lifecycle that the job is currently in.", "type": "string", "enum": [ "queued", "in_progress", "completed" ], "examples": [ "queued" ] }, "conclusion": { "description": "The outcome of the job.", "type": [ "string", "null" ], "examples": [ "success" ] }, "name": { "description": "The name of the job.", "type": "string", "examples": [ "test-coverage" ] }, "number": { "type": "integer", "examples": [ 1 ] }, "started_at": { "description": "The time that the step started, in ISO 8601 format.", "format": "date-time", "type": [ "string", "null" ], "examples": [ "2019-08-08T08:00:00-07:00" ] }, "completed_at": { "description": "The time that the job finished, in ISO 8601 format.", "format": "date-time", "type": [ "string", "null" ], "examples": [ "2019-08-08T08:00:00-07:00" ] } } } }, "check_run_url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-runs/4" ] }, "labels": { "type": "array", "items": { "type": "string" }, "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", "examples": [ "self-hosted", "foo", "bar" ] }, "runner_id": { "type": [ "integer", "null" ], "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", "examples": [ 1 ] }, "runner_name": { "type": [ "string", "null" ], "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", "examples": [ "my runner" ] }, "runner_group_id": { "type": [ "integer", "null" ], "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", "examples": [ 2 ] }, "runner_group_name": { "type": [ "string", "null" ], "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", "examples": [ "my runner group" ] } }, "required": [ "id", "node_id", "run_id", "run_url", "head_sha", "name", "url", "html_url", "status", "conclusion", "started_at", "completed_at", "check_run_url", "labels", "runner_id", "runner_name", "runner_group_id", "runner_group_name" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
OK
" } ] } ], "workflow-runs": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun", "title": "Re-run a job from a workflow run", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "job_id", "description": "The unique identifier of the job.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "boolean", "name": "enable_debug_logging", "in": "body", "description": "Whether to enable debug logging for the re-run.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": null, "parameters": { "owner": "OWNER", "repo": "REPO", "job_id": "JOB_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": null, "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false } } } ], "previews": [], "descriptionHTML": "Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs", "title": "List workflow runs for a repository", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "actor", "description": "Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.
Returns workflow runs associated with a branch. Use the name of the branch of the push.
Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"
Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub can set a status of waiting or requested.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "created", "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"
", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "exclude_pull_requests", "description": "If true pull requests are omitted from the response (empty array).
Returns workflow runs with the check_suite_id that you specify.
Only returns workflow runs that are associated with the specified head_sha.
Response
", "example": { "total_count": 1, "workflow_runs": [ { "id": 30433642, "name": "Build", "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", "check_suite_id": 42, "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", "head_branch": "master", "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", "run_number": 562, "event": "push", "status": "queued", "conclusion": null, "workflow_id": 159038, "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", "pull_requests": [], "created_at": "2020-01-22T19:33:08Z", "updated_at": "2020-01-22T19:33:08Z", "actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "run_attempt": 1, "run_started_at": "2020-01-22T19:33:08Z", "triggering_actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", "head_commit": { "id": "acb5820ced9479c074f688cc328bf03f341a511d", "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", "message": "Create linter.yaml", "timestamp": "2020-01-22T19:33:05Z", "author": { "name": "Octo Cat", "email": "octocat@github.com" }, "committer": { "name": "GitHub", "email": "noreply@github.com" } }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "head_repository": { "id": 217723378, "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", "name": "octo-repo", "full_name": "octo-org/octo-repo", "private": true, "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "html_url": "https://github.com/octo-org/octo-repo", "description": null, "fork": false, "url": "https://api.github.com/repos/octo-org/octo-repo", "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" } } ] }, "schema": { "type": "object", "required": [ "total_count", "workflow_runs" ], "properties": { "total_count": { "type": "integer" }, "workflow_runs": { "type": "array", "items": { "title": "Workflow Run", "description": "An invocation of a workflow", "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the workflow run.", "examples": [ 5 ] }, "name": { "type": [ "string", "null" ], "description": "The name of the workflow run.", "examples": [ "Build" ] }, "node_id": { "type": "string", "examples": [ "MDEwOkNoZWNrU3VpdGU1" ] }, "check_suite_id": { "type": "integer", "description": "The ID of the associated check suite.", "examples": [ 42 ] }, "check_suite_node_id": { "type": "string", "description": "The node ID of the associated check suite.", "examples": [ "MDEwOkNoZWNrU3VpdGU0Mg==" ] }, "head_branch": { "type": [ "string", "null" ], "examples": [ "master" ] }, "head_sha": { "description": "The SHA of the head commit that points to the version of the workflow being run.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "path": { "description": "The full path of the workflow", "type": "string", "examples": [ "octocat/octo-repo/.github/workflows/ci.yml@main" ] }, "run_number": { "type": "integer", "description": "The auto incrementing run number for the workflow run.", "examples": [ 106 ] }, "run_attempt": { "type": "integer", "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.", "examples": [ 1 ] }, "referenced_workflows": { "type": [ "array", "null" ], "items": { "title": "Referenced workflow", "description": "A workflow referenced/reused by the initial caller workflow", "type": "object", "properties": { "path": { "type": "string" }, "sha": { "type": "string" }, "ref": { "type": "string" } }, "required": [ "path", "sha" ] } }, "event": { "type": "string", "examples": [ "push" ] }, "status": { "type": [ "string", "null" ], "examples": [ "completed" ] }, "conclusion": { "type": [ "string", "null" ], "examples": [ "neutral" ] }, "workflow_id": { "type": "integer", "description": "The ID of the parent workflow.", "examples": [ 5 ] }, "url": { "type": "string", "description": "The URL to the workflow run.", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/github/hello-world/suites/4" ] }, "pull_requests": { "type": [ "array", "null" ], "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "triggering_actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "run_started_at": { "type": "string", "format": "date-time", "description": "The start time of the latest run. Resets on re-run." }, "jobs_url": { "description": "The URL to the jobs for the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs" ] }, "logs_url": { "description": "The URL to download the logs for the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/logs" ] }, "check_suite_url": { "description": "The URL to the associated check suite.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-suites/12" ] }, "artifacts_url": { "description": "The URL to the artifacts for the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts" ] }, "cancel_url": { "description": "The URL to cancel the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel" ] }, "rerun_url": { "description": "The URL to rerun the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" ] }, "previous_attempt_url": { "description": "The URL to the previous attempted run of this workflow, if one exists.", "type": [ "string", "null" ], "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" ] }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" ] }, "head_commit": { "anyOf": [ { "type": "null" }, { "title": "Simple Commit", "description": "Simple Commit", "type": "object", "properties": { "id": { "type": "string" }, "tree_id": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "author": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "committer": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] } }, "required": [ "id", "tree_id", "message", "timestamp", "author", "committer" ] } ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "head_repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "head_repository_id": { "type": "integer", "examples": [ 5 ] } }, "required": [ "id", "node_id", "head_branch", "run_number", "event", "status", "conclusion", "head_sha", "path", "workflow_id", "url", "html_url", "created_at", "updated_at", "head_commit", "head_repository", "repository", "jobs_url", "logs_url", "check_suite_url", "cancel_url", "rerun_url", "artifacts_url", "workflow_url", "pull_requests" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", "title": "Get a workflow run", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "exclude_pull_requests", "description": "If true pull requests are omitted from the response (empty array).
Response
", "example": { "id": 30433642, "name": "Build", "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", "check_suite_id": 42, "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", "head_branch": "main", "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", "path": ".github/workflows/build.yml@main", "run_number": 562, "event": "push", "status": "queued", "conclusion": null, "workflow_id": 159038, "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", "pull_requests": [], "created_at": "2020-01-22T19:33:08Z", "updated_at": "2020-01-22T19:33:08Z", "actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "run_attempt": 1, "referenced_workflows": [ { "path": "octocat/Hello-World/.github/workflows/deploy.yml@main", "sha": "86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db", "ref": "refs/heads/main" }, { "path": "octo-org/octo-repo/.github/workflows/report.yml@v2", "sha": "79e9790903e1c3373b1a3e3a941d57405478a232", "ref": "refs/tags/v2" }, { "path": "octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e", "sha": "1595d4b6de6a9e9751fb270a41019ce507d4099e" } ], "run_started_at": "2020-01-22T19:33:08Z", "triggering_actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", "previous_attempt_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1", "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", "head_commit": { "id": "acb5820ced9479c074f688cc328bf03f341a511d", "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", "message": "Create linter.yaml", "timestamp": "2020-01-22T19:33:05Z", "author": { "name": "Octo Cat", "email": "octocat@github.com" }, "committer": { "name": "GitHub", "email": "noreply@github.com" } }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "head_repository": { "id": 217723378, "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", "name": "octo-repo", "full_name": "octo-org/octo-repo", "private": true, "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "html_url": "https://github.com/octo-org/octo-repo", "description": null, "fork": false, "url": "https://api.github.com/repos/octo-org/octo-repo", "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" } }, "schema": { "title": "Workflow Run", "description": "An invocation of a workflow", "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the workflow run.", "examples": [ 5 ] }, "name": { "type": [ "string", "null" ], "description": "The name of the workflow run.", "examples": [ "Build" ] }, "node_id": { "type": "string", "examples": [ "MDEwOkNoZWNrU3VpdGU1" ] }, "check_suite_id": { "type": "integer", "description": "The ID of the associated check suite.", "examples": [ 42 ] }, "check_suite_node_id": { "type": "string", "description": "The node ID of the associated check suite.", "examples": [ "MDEwOkNoZWNrU3VpdGU0Mg==" ] }, "head_branch": { "type": [ "string", "null" ], "examples": [ "master" ] }, "head_sha": { "description": "The SHA of the head commit that points to the version of the workflow being run.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "path": { "description": "The full path of the workflow", "type": "string", "examples": [ "octocat/octo-repo/.github/workflows/ci.yml@main" ] }, "run_number": { "type": "integer", "description": "The auto incrementing run number for the workflow run.", "examples": [ 106 ] }, "run_attempt": { "type": "integer", "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.", "examples": [ 1 ] }, "referenced_workflows": { "type": [ "array", "null" ], "items": { "title": "Referenced workflow", "description": "A workflow referenced/reused by the initial caller workflow", "type": "object", "properties": { "path": { "type": "string" }, "sha": { "type": "string" }, "ref": { "type": "string" } }, "required": [ "path", "sha" ] } }, "event": { "type": "string", "examples": [ "push" ] }, "status": { "type": [ "string", "null" ], "examples": [ "completed" ] }, "conclusion": { "type": [ "string", "null" ], "examples": [ "neutral" ] }, "workflow_id": { "type": "integer", "description": "The ID of the parent workflow.", "examples": [ 5 ] }, "url": { "type": "string", "description": "The URL to the workflow run.", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/github/hello-world/suites/4" ] }, "pull_requests": { "type": [ "array", "null" ], "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "triggering_actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "run_started_at": { "type": "string", "format": "date-time", "description": "The start time of the latest run. Resets on re-run." }, "jobs_url": { "description": "The URL to the jobs for the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs" ] }, "logs_url": { "description": "The URL to download the logs for the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/logs" ] }, "check_suite_url": { "description": "The URL to the associated check suite.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-suites/12" ] }, "artifacts_url": { "description": "The URL to the artifacts for the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts" ] }, "cancel_url": { "description": "The URL to cancel the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel" ] }, "rerun_url": { "description": "The URL to rerun the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" ] }, "previous_attempt_url": { "description": "The URL to the previous attempted run of this workflow, if one exists.", "type": [ "string", "null" ], "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" ] }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" ] }, "head_commit": { "anyOf": [ { "type": "null" }, { "title": "Simple Commit", "description": "Simple Commit", "type": "object", "properties": { "id": { "type": "string" }, "tree_id": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "author": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "committer": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] } }, "required": [ "id", "tree_id", "message", "timestamp", "author", "committer" ] } ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "head_repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "head_repository_id": { "type": "integer", "examples": [ 5 ] } }, "required": [ "id", "node_id", "head_branch", "run_number", "event", "status", "conclusion", "head_sha", "path", "workflow_id", "url", "html_url", "created_at", "updated_at", "head_commit", "head_repository", "repository", "jobs_url", "logs_url", "check_suite_url", "cancel_url", "rerun_url", "artifacts_url", "workflow_url", "pull_requests" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", "title": "Delete a workflow run", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is\nprivate you must use an access token with the repo scope. GitHub Apps must have the actions:write permission to use\nthis endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", "title": "Get the review history for a workflow run", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "state": "approved", "comment": "Ship it!", "environments": [ { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", "name": "staging", "url": "https://api.github.com/repos/github/hello-world/environments/staging", "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", "created_at": "2020-11-23T22:00:40Z", "updated_at": "2020-11-23T22:00:40Z" } ], "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } ], "schema": { "type": "array", "items": { "title": "Environment Approval", "description": "An entry in the reviews log for environment deployments", "type": "object", "properties": { "environments": { "description": "The list of environments that were approved or rejected", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "The id of the environment.", "type": "integer", "examples": [ 56780428 ] }, "node_id": { "type": "string", "examples": [ "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" ] }, "name": { "description": "The name of the environment.", "type": "string", "examples": [ "staging" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/environments/staging" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" ] }, "created_at": { "description": "The time that the environment was created, in ISO 8601 format.", "format": "date-time", "type": "string", "examples": [ "2020-11-23T22:00:40Z" ] }, "updated_at": { "description": "The time that the environment was last updated, in ISO 8601 format.", "format": "date-time", "type": "string", "examples": [ "2020-11-23T22:00:40Z" ] } } } }, "state": { "description": "Whether deployment to the environment(s) was approved or rejected", "enum": [ "approved", "rejected" ], "type": "string", "examples": [ "approved" ] }, "user": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "comment": { "type": "string", "description": "The comment submitted with the deployment review", "examples": [ "Ship it!" ] } }, "required": [ "environments", "state", "user", "comment" ] } } } } ], "previews": [], "descriptionHTML": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/approve", "title": "Approve a workflow run for a fork pull request", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": null, "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false } } } ], "previews": [], "descriptionHTML": "Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see \"Approving workflow runs from public forks.\"
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}", "title": "Get a workflow run attempt", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "attempt_number", "description": "The attempt number of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "exclude_pull_requests", "description": "If true pull requests are omitted from the response (empty array).
Response
", "example": { "id": 30433642, "name": "Build", "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", "check_suite_id": 42, "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", "head_branch": "main", "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", "path": ".github/workflows/build.yml@main", "run_number": 562, "event": "push", "status": "queued", "conclusion": null, "workflow_id": 159038, "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", "pull_requests": [], "created_at": "2020-01-22T19:33:08Z", "updated_at": "2020-01-22T19:33:08Z", "actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "run_attempt": 1, "referenced_workflows": [ { "path": "octocat/Hello-World/.github/workflows/deploy.yml@main", "sha": "86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db", "ref": "refs/heads/main" }, { "path": "octo-org/octo-repo/.github/workflows/report.yml@v2", "sha": "79e9790903e1c3373b1a3e3a941d57405478a232", "ref": "refs/tags/v2" }, { "path": "octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e", "sha": "1595d4b6de6a9e9751fb270a41019ce507d4099e" } ], "run_started_at": "2020-01-22T19:33:08Z", "triggering_actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", "previous_attempt_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1", "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", "head_commit": { "id": "acb5820ced9479c074f688cc328bf03f341a511d", "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", "message": "Create linter.yaml", "timestamp": "2020-01-22T19:33:05Z", "author": { "name": "Octo Cat", "email": "octocat@github.com" }, "committer": { "name": "GitHub", "email": "noreply@github.com" } }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "head_repository": { "id": 217723378, "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", "name": "octo-repo", "full_name": "octo-org/octo-repo", "private": true, "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "html_url": "https://github.com/octo-org/octo-repo", "description": null, "fork": false, "url": "https://api.github.com/repos/octo-org/octo-repo", "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" } }, "schema": { "title": "Workflow Run", "description": "An invocation of a workflow", "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the workflow run.", "examples": [ 5 ] }, "name": { "type": [ "string", "null" ], "description": "The name of the workflow run.", "examples": [ "Build" ] }, "node_id": { "type": "string", "examples": [ "MDEwOkNoZWNrU3VpdGU1" ] }, "check_suite_id": { "type": "integer", "description": "The ID of the associated check suite.", "examples": [ 42 ] }, "check_suite_node_id": { "type": "string", "description": "The node ID of the associated check suite.", "examples": [ "MDEwOkNoZWNrU3VpdGU0Mg==" ] }, "head_branch": { "type": [ "string", "null" ], "examples": [ "master" ] }, "head_sha": { "description": "The SHA of the head commit that points to the version of the workflow being run.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "path": { "description": "The full path of the workflow", "type": "string", "examples": [ "octocat/octo-repo/.github/workflows/ci.yml@main" ] }, "run_number": { "type": "integer", "description": "The auto incrementing run number for the workflow run.", "examples": [ 106 ] }, "run_attempt": { "type": "integer", "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.", "examples": [ 1 ] }, "referenced_workflows": { "type": [ "array", "null" ], "items": { "title": "Referenced workflow", "description": "A workflow referenced/reused by the initial caller workflow", "type": "object", "properties": { "path": { "type": "string" }, "sha": { "type": "string" }, "ref": { "type": "string" } }, "required": [ "path", "sha" ] } }, "event": { "type": "string", "examples": [ "push" ] }, "status": { "type": [ "string", "null" ], "examples": [ "completed" ] }, "conclusion": { "type": [ "string", "null" ], "examples": [ "neutral" ] }, "workflow_id": { "type": "integer", "description": "The ID of the parent workflow.", "examples": [ 5 ] }, "url": { "type": "string", "description": "The URL to the workflow run.", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/github/hello-world/suites/4" ] }, "pull_requests": { "type": [ "array", "null" ], "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "triggering_actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "run_started_at": { "type": "string", "format": "date-time", "description": "The start time of the latest run. Resets on re-run." }, "jobs_url": { "description": "The URL to the jobs for the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs" ] }, "logs_url": { "description": "The URL to download the logs for the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/logs" ] }, "check_suite_url": { "description": "The URL to the associated check suite.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-suites/12" ] }, "artifacts_url": { "description": "The URL to the artifacts for the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts" ] }, "cancel_url": { "description": "The URL to cancel the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel" ] }, "rerun_url": { "description": "The URL to rerun the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" ] }, "previous_attempt_url": { "description": "The URL to the previous attempted run of this workflow, if one exists.", "type": [ "string", "null" ], "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" ] }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" ] }, "head_commit": { "anyOf": [ { "type": "null" }, { "title": "Simple Commit", "description": "Simple Commit", "type": "object", "properties": { "id": { "type": "string" }, "tree_id": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "author": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "committer": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] } }, "required": [ "id", "tree_id", "message", "timestamp", "author", "committer" ] } ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "head_repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "head_repository_id": { "type": "integer", "examples": [ 5 ] } }, "required": [ "id", "node_id", "head_branch", "run_number", "event", "status", "conclusion", "head_sha", "path", "workflow_id", "url", "html_url", "created_at", "updated_at", "head_commit", "head_repository", "repository", "jobs_url", "logs_url", "check_suite_url", "cancel_url", "rerun_url", "artifacts_url", "workflow_url", "pull_requests" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific workflow run attempt. Anyone with read access to the repository\ncan use this endpoint. If the repository is private you must use an access token\nwith the repo scope. GitHub Apps must have the actions:read permission to\nuse this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs", "title": "Download workflow run attempt logs", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "attempt_number", "description": "The attempt number of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID", "attempt_number": "ATTEMPT_NUMBER" } }, "response": { "statusCode": "302", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for Location: in the response header to find the URL for the download. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the actions:read permission to use this endpoint.
Found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", "title": "Cancel a workflow run", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID" } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response
", "example": null, "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false } } } ], "previews": [], "descriptionHTML": "Cancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Accepted
" }, { "httpStatusCode": "409", "description": "Conflict
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", "title": "Download workflow run logs", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID" } }, "response": { "statusCode": "302", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\nLocation: in the response header to find the URL for the download. Anyone with read access to the repository can use\nthis endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have\nthe actions:read permission to use this endpoint.
Found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", "title": "Delete workflow run logs", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes all logs for a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", "title": "Get pending deployments for a workflow run", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "environment": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", "name": "staging", "url": "https://api.github.com/repos/github/hello-world/environments/staging", "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" }, "wait_timer": 30, "wait_timer_started_at": "2020-11-23T22:00:40Z", "current_user_can_approve": true, "reviewers": [ { "type": "User", "reviewer": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, { "type": "Team", "reviewer": { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } } ] } ], "schema": { "type": "array", "items": { "title": "Pending Deployment", "description": "Details of a deployment that is waiting for protection rules to pass", "type": "object", "properties": { "environment": { "type": "object", "properties": { "id": { "description": "The id of the environment.", "type": "integer", "examples": [ 56780428 ] }, "node_id": { "type": "string", "examples": [ "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" ] }, "name": { "description": "The name of the environment.", "type": "string", "examples": [ "staging" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/environments/staging" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" ] } } }, "wait_timer": { "type": "integer", "description": "The set duration of the wait timer", "examples": [ 30 ] }, "wait_timer_started_at": { "description": "The time that the wait timer began.", "format": "date-time", "type": [ "string", "null" ], "examples": [ "2020-11-23T22:00:40Z" ] }, "current_user_can_approve": { "description": "Whether the currently authenticated user can approve the deployment", "type": "boolean", "examples": [ true ] }, "reviewers": { "type": "array", "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of reviewer.", "enum": [ "User", "Team" ], "examples": [ "User" ] }, "reviewer": { "anyOf": [ { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } ] } } } } }, "required": [ "environment", "wait_timer", "wait_timer_started_at", "current_user_can_approve", "reviewers" ] } } } } ], "previews": [], "descriptionHTML": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.
\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", "title": "Review pending deployments for a workflow run", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of integers", "name": "environment_ids", "in": "body", "description": "The list of environment ids to approve or reject
", "isRequired": true }, { "type": "string", "name": "state", "in": "body", "description": "Whether to approve or reject deployment to the specified environments.
", "isRequired": true, "enum": [ "approved", "rejected" ] }, { "type": "string", "name": "comment", "in": "body", "description": "A comment to accompany the deployment review
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "environment_ids": [ 161171787 ], "state": "approved", "comment": "Ship it!" }, "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, "node_id": "MDEwOkRlcGxveW1lbnQx", "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", "ref": "topic-branch", "task": "deploy", "payload": {}, "original_environment": "staging", "environment": "production", "description": "Deploy request from hubot", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", "repository_url": "https://api.github.com/repos/octocat/example", "transient_environment": false, "production_environment": true } ], "schema": { "type": "array", "items": { "title": "Deployment", "description": "A request for a specific ref(branch,sha,tag) to be deployed", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1" ] }, "id": { "description": "Unique identifier of the deployment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkRlcGxveW1lbnQx" ] }, "sha": { "type": "string", "examples": [ "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" ] }, "ref": { "description": "The ref to deploy. This can be a branch, tag, or sha.", "type": "string", "examples": [ "topic-branch" ] }, "task": { "description": "Parameter to specify a task to execute", "type": "string", "examples": [ "deploy" ] }, "payload": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" } ] }, "original_environment": { "type": "string", "examples": [ "staging" ] }, "environment": { "description": "Name for the target deployment environment.", "type": "string", "examples": [ "production" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Deploy request from hubot" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] }, "transient_environment": { "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", "type": "boolean", "examples": [ true ] }, "production_environment": { "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", "type": "boolean", "examples": [ true ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "sha", "ref", "task", "environment", "creator", "payload", "description", "statuses_url", "repository_url", "url", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Approve or reject pending deployments that are waiting on approval by a required reviewer.
\nRequired reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the repo scope to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", "title": "Re-run a workflow", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "boolean", "name": "enable_debug_logging", "in": "body", "description": "Whether to enable debug logging for the re-run.
" } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": null, "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": null, "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false } } } ], "previews": [], "descriptionHTML": "Re-runs your workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs", "title": "Re-run failed jobs from a workflow run", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "boolean", "name": "enable_debug_logging", "in": "body", "description": "Whether to enable debug logging for the re-run.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": null, "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": null, "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false } } } ], "previews": [], "descriptionHTML": "Re-run all of the failed jobs and their dependent jobs in a workflow run using the id of the workflow run. You must authenticate using an access token with the repo scope to use this endpoint.
Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing", "title": "Get workflow run usage", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "description": "The unique identifier of the workflow run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "run_id": "RUN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "billable": { "UBUNTU": { "total_ms": 180000, "jobs": 1, "job_runs": [ { "job_id": 1, "duration_ms": 180000 } ] }, "MACOS": { "total_ms": 240000, "jobs": 4, "job_runs": [ { "job_id": 2, "duration_ms": 60000 }, { "job_id": 3, "duration_ms": 60000 }, { "job_id": 4, "duration_ms": 60000 }, { "job_id": 5, "duration_ms": 60000 } ] }, "WINDOWS": { "total_ms": 300000, "jobs": 2, "job_runs": [ { "job_id": 6, "duration_ms": 150000 }, { "job_id": 7, "duration_ms": 150000 } ] } }, "run_duration_ms": 500000 }, "schema": { "title": "Workflow Run Usage", "description": "Workflow Run Usage", "type": "object", "properties": { "billable": { "type": "object", "properties": { "UBUNTU": { "type": "object", "required": [ "total_ms", "jobs" ], "properties": { "total_ms": { "type": "integer" }, "jobs": { "type": "integer" }, "job_runs": { "type": "array", "items": { "type": "object", "required": [ "job_id", "duration_ms" ], "properties": { "job_id": { "type": "integer" }, "duration_ms": { "type": "integer" } } } } } }, "MACOS": { "type": "object", "required": [ "total_ms", "jobs" ], "properties": { "total_ms": { "type": "integer" }, "jobs": { "type": "integer" }, "job_runs": { "type": "array", "items": { "type": "object", "required": [ "job_id", "duration_ms" ], "properties": { "job_id": { "type": "integer" }, "duration_ms": { "type": "integer" } } } } } }, "WINDOWS": { "type": "object", "required": [ "total_ms", "jobs" ], "properties": { "total_ms": { "type": "integer" }, "jobs": { "type": "integer" }, "job_runs": { "type": "array", "items": { "type": "object", "required": [ "job_id", "duration_ms" ], "properties": { "job_id": { "type": "integer" }, "duration_ms": { "type": "integer" } } } } } } } }, "run_duration_ms": { "type": "integer" } }, "required": [ "billable" ] } } } ], "previews": [], "descriptionHTML": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", "title": "List workflow runs for a workflow", "category": "actions", "subcategory": "workflow-runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflow_id", "in": "path", "description": "The ID of the workflow. You can also pass the workflow file name as a string.
", "required": true, "schema": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] } }, { "name": "actor", "description": "Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.
Returns workflow runs associated with a branch. Use the name of the branch of the push.
Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"
Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub can set a status of waiting or requested.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "created", "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"
", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "exclude_pull_requests", "description": "If true pull requests are omitted from the response (empty array).
Returns workflow runs with the check_suite_id that you specify.
Only returns workflow runs that are associated with the specified head_sha.
Response
", "example": { "total_count": 1, "workflow_runs": [ { "id": 30433642, "name": "Build", "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", "check_suite_id": 42, "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", "head_branch": "master", "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", "run_number": 562, "event": "push", "status": "queued", "conclusion": null, "workflow_id": 159038, "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", "pull_requests": [], "created_at": "2020-01-22T19:33:08Z", "updated_at": "2020-01-22T19:33:08Z", "actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "run_attempt": 1, "run_started_at": "2020-01-22T19:33:08Z", "triggering_actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", "head_commit": { "id": "acb5820ced9479c074f688cc328bf03f341a511d", "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", "message": "Create linter.yaml", "timestamp": "2020-01-22T19:33:05Z", "author": { "name": "Octo Cat", "email": "octocat@github.com" }, "committer": { "name": "GitHub", "email": "noreply@github.com" } }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "head_repository": { "id": 217723378, "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", "name": "octo-repo", "full_name": "octo-org/octo-repo", "private": true, "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "html_url": "https://github.com/octo-org/octo-repo", "description": null, "fork": false, "url": "https://api.github.com/repos/octo-org/octo-repo", "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" } } ] }, "schema": { "type": "object", "required": [ "total_count", "workflow_runs" ], "properties": { "total_count": { "type": "integer" }, "workflow_runs": { "type": "array", "items": { "title": "Workflow Run", "description": "An invocation of a workflow", "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the workflow run.", "examples": [ 5 ] }, "name": { "type": [ "string", "null" ], "description": "The name of the workflow run.", "examples": [ "Build" ] }, "node_id": { "type": "string", "examples": [ "MDEwOkNoZWNrU3VpdGU1" ] }, "check_suite_id": { "type": "integer", "description": "The ID of the associated check suite.", "examples": [ 42 ] }, "check_suite_node_id": { "type": "string", "description": "The node ID of the associated check suite.", "examples": [ "MDEwOkNoZWNrU3VpdGU0Mg==" ] }, "head_branch": { "type": [ "string", "null" ], "examples": [ "master" ] }, "head_sha": { "description": "The SHA of the head commit that points to the version of the workflow being run.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "path": { "description": "The full path of the workflow", "type": "string", "examples": [ "octocat/octo-repo/.github/workflows/ci.yml@main" ] }, "run_number": { "type": "integer", "description": "The auto incrementing run number for the workflow run.", "examples": [ 106 ] }, "run_attempt": { "type": "integer", "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.", "examples": [ 1 ] }, "referenced_workflows": { "type": [ "array", "null" ], "items": { "title": "Referenced workflow", "description": "A workflow referenced/reused by the initial caller workflow", "type": "object", "properties": { "path": { "type": "string" }, "sha": { "type": "string" }, "ref": { "type": "string" } }, "required": [ "path", "sha" ] } }, "event": { "type": "string", "examples": [ "push" ] }, "status": { "type": [ "string", "null" ], "examples": [ "completed" ] }, "conclusion": { "type": [ "string", "null" ], "examples": [ "neutral" ] }, "workflow_id": { "type": "integer", "description": "The ID of the parent workflow.", "examples": [ 5 ] }, "url": { "type": "string", "description": "The URL to the workflow run.", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/github/hello-world/suites/4" ] }, "pull_requests": { "type": [ "array", "null" ], "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "triggering_actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "run_started_at": { "type": "string", "format": "date-time", "description": "The start time of the latest run. Resets on re-run." }, "jobs_url": { "description": "The URL to the jobs for the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs" ] }, "logs_url": { "description": "The URL to download the logs for the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/logs" ] }, "check_suite_url": { "description": "The URL to the associated check suite.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-suites/12" ] }, "artifacts_url": { "description": "The URL to the artifacts for the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts" ] }, "cancel_url": { "description": "The URL to cancel the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel" ] }, "rerun_url": { "description": "The URL to rerun the workflow run.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" ] }, "previous_attempt_url": { "description": "The URL to the previous attempted run of this workflow, if one exists.", "type": [ "string", "null" ], "examples": [ "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" ] }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" ] }, "head_commit": { "anyOf": [ { "type": "null" }, { "title": "Simple Commit", "description": "Simple Commit", "type": "object", "properties": { "id": { "type": "string" }, "tree_id": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "author": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "committer": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] } }, "required": [ "id", "tree_id", "message", "timestamp", "author", "committer" ] } ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "head_repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "head_repository_id": { "type": "integer", "examples": [ 5 ] } }, "required": [ "id", "node_id", "head_branch", "run_number", "event", "status", "conclusion", "head_sha", "path", "workflow_id", "url", "html_url", "created_at", "updated_at", "head_commit", "head_repository", "repository", "jobs_url", "logs_url", "check_suite_url", "cancel_url", "rerun_url", "artifacts_url", "workflow_url", "pull_requests" ] } } } } } } ], "previews": [], "descriptionHTML": "List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope.
OK
" } ] } ], "workflows": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/workflows", "title": "List repository workflows", "category": "actions", "subcategory": "workflows", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "workflows": [ { "id": 161335, "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", "name": "CI", "path": ".github/workflows/blank.yaml", "state": "active", "created_at": "2020-01-08T23:48:37.000-08:00", "updated_at": "2020-01-08T23:50:21.000-08:00", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335", "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335", "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" }, { "id": 269289, "node_id": "MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==", "name": "Linter", "path": ".github/workflows/linter.yaml", "state": "active", "created_at": "2020-01-08T23:48:37.000-08:00", "updated_at": "2020-01-08T23:50:21.000-08:00", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289", "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289", "badge_url": "https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg" } ] }, "schema": { "type": "object", "required": [ "total_count", "workflows" ], "properties": { "total_count": { "type": "integer" }, "workflows": { "type": "array", "items": { "title": "Workflow", "description": "A GitHub Actions workflow", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 5 ] }, "node_id": { "type": "string", "examples": [ "MDg6V29ya2Zsb3cxMg==" ] }, "name": { "type": "string", "examples": [ "CI" ] }, "path": { "type": "string", "examples": [ "ruby.yaml" ] }, "state": { "type": "string", "enum": [ "active", "deleted", "disabled_fork", "disabled_inactivity", "disabled_manually" ], "examples": [ "active" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2019-12-06T14:20:20.000Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2019-12-06T14:20:20.000Z" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/actions/setup-ruby/workflows/5" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml" ] }, "badge_url": { "type": "string", "examples": [ "https://github.com/actions/setup-ruby/workflows/CI/badge.svg" ] }, "deleted_at": { "type": "string", "format": "date-time", "examples": [ "2019-12-06T14:20:20.000Z" ] } }, "required": [ "id", "node_id", "name", "path", "state", "url", "html_url", "badge_url", "created_at", "updated_at" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", "title": "Get a workflow", "category": "actions", "subcategory": "workflows", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflow_id", "in": "path", "description": "The ID of the workflow. You can also pass the workflow file name as a string.
", "required": true, "schema": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "workflow_id": "WORKFLOW_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 161335, "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", "name": "CI", "path": ".github/workflows/blank.yaml", "state": "active", "created_at": "2020-01-08T23:48:37.000-08:00", "updated_at": "2020-01-08T23:50:21.000-08:00", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335", "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335", "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" }, "schema": { "title": "Workflow", "description": "A GitHub Actions workflow", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 5 ] }, "node_id": { "type": "string", "examples": [ "MDg6V29ya2Zsb3cxMg==" ] }, "name": { "type": "string", "examples": [ "CI" ] }, "path": { "type": "string", "examples": [ "ruby.yaml" ] }, "state": { "type": "string", "enum": [ "active", "deleted", "disabled_fork", "disabled_inactivity", "disabled_manually" ], "examples": [ "active" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2019-12-06T14:20:20.000Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2019-12-06T14:20:20.000Z" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/actions/setup-ruby/workflows/5" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml" ] }, "badge_url": { "type": "string", "examples": [ "https://github.com/actions/setup-ruby/workflows/CI/badge.svg" ] }, "deleted_at": { "type": "string", "format": "date-time", "examples": [ "2019-12-06T14:20:20.000Z" ] } }, "required": [ "id", "node_id", "name", "path", "state", "url", "html_url", "badge_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", "title": "Disable a workflow", "category": "actions", "subcategory": "workflows", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflow_id", "in": "path", "description": "The ID of the workflow. You can also pass the workflow file name as a string.
", "required": true, "schema": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "workflow_id": "WORKFLOW_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Disables a workflow and sets the state of the workflow to disabled_manually. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", "title": "Create a workflow dispatch event", "category": "actions", "subcategory": "workflows", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflow_id", "in": "path", "description": "The ID of the workflow. You can also pass the workflow file name as a string.
", "required": true, "schema": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] } } ], "bodyParameters": [ { "type": "string", "name": "ref", "in": "body", "description": "The git reference for the workflow. The reference can be a branch or tag name.
", "isRequired": true }, { "type": "object", "name": "inputs", "in": "body", "description": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.
Response
" } } ], "previews": [], "descriptionHTML": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.
You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see \"Events that trigger workflows.\"
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint. For more information, see \"Creating a personal access token for the command line.\"
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", "title": "Enable a workflow", "category": "actions", "subcategory": "workflows", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflow_id", "in": "path", "description": "The ID of the workflow. You can also pass the workflow file name as a string.
", "required": true, "schema": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "workflow_id": "WORKFLOW_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Enables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing", "title": "Get workflow usage", "category": "actions", "subcategory": "workflows", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflow_id", "in": "path", "description": "The ID of the workflow. You can also pass the workflow file name as a string.
", "required": true, "schema": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "workflow_id": "WORKFLOW_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "billable": { "UBUNTU": { "total_ms": 180000 }, "MACOS": { "total_ms": 240000 }, "WINDOWS": { "total_ms": 300000 } } }, "schema": { "title": "Workflow Usage", "description": "Workflow Usage", "type": "object", "properties": { "billable": { "type": "object", "properties": { "UBUNTU": { "type": "object", "properties": { "total_ms": { "type": "integer" } } }, "MACOS": { "type": "object", "properties": { "total_ms": { "type": "integer" } } }, "WINDOWS": { "type": "object", "properties": { "total_ms": { "type": "integer" } } } } } }, "required": [ "billable" ] } } } ], "previews": [], "descriptionHTML": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nYou can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] } ] }, "activity": { "events": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/events", "title": "List public events", "category": "activity", "subcategory": "events", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": "22249084947", "type": "WatchEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "action": "started" }, "public": true, "created_at": "2022-06-09T12:47:28Z" }, { "id": "22249084964", "type": "PushEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "push_id": 10115855396, "size": 1, "distinct_size": 1, "ref": "refs/heads/master", "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "before": "883efe034920928c47fe18598c01249d1a9fdabd", "commits": [ { "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "author": { "email": "octocat@github.com", "name": "Monalisa Octocat" }, "message": "commit", "distinct": true, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" } ] }, "public": true, "created_at": "2022-06-07T07:50:26Z" } ], "schema": { "type": "array", "items": { "title": "Event", "description": "Event", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": [ "string", "null" ] }, "actor": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "url" ] }, "org": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "payload": { "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] }, "comment": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] }, "pages": { "type": "array", "items": { "type": "object", "properties": { "page_name": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "action": { "type": "string" }, "sha": { "type": "string" }, "html_url": { "type": "string" } } } } } }, "public": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "type", "actor", "repo", "payload", "public", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/networks/{owner}/{repo}/events", "title": "List public events for a network of repositories", "category": "activity", "subcategory": "events", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": "22249084964", "type": "PushEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "push_id": 10115855396, "size": 1, "distinct_size": 1, "ref": "refs/heads/master", "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "before": "883efe034920928c47fe18598c01249d1a9fdabd", "commits": [ { "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "author": { "email": "octocat@github.com", "name": "Monalisa Octocat" }, "message": "commit", "distinct": true, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" } ] }, "public": true, "created_at": "2022-06-09T12:47:28Z" }, { "id": "22237752260", "type": "WatchEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/rrubenich", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "action": "started" }, "public": true, "created_at": "2022-06-08T23:29:25Z" } ], "schema": { "type": "array", "items": { "title": "Event", "description": "Event", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": [ "string", "null" ] }, "actor": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "url" ] }, "org": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "payload": { "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] }, "comment": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] }, "pages": { "type": "array", "items": { "type": "object", "properties": { "page_name": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "action": { "type": "string" }, "sha": { "type": "string" }, "html_url": { "type": "string" } } } } } }, "public": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "type", "actor", "repo", "payload", "public", "created_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "301", "description": "Moved permanently
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/events", "title": "List public organization events", "category": "activity", "subcategory": "events", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": "22237752260", "type": "WatchEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octo-org/octo-repo", "url": "https://api.github.com/repos/octo-org/octo-repo" }, "payload": { "action": "started" }, "public": true, "created_at": "2022-06-08T23:29:25Z" }, { "id": "22249084964", "type": "PushEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octo-org/octo-repo", "url": "https://api.github.com/repos/octo-org/oct-repo" }, "payload": { "push_id": 10115855396, "size": 1, "distinct_size": 1, "ref": "refs/heads/master", "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "before": "883efe034920928c47fe18598c01249d1a9fdabd", "commits": [ { "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "author": { "email": "octocat@github.com", "name": "Monalisa Octocat" }, "message": "commit", "distinct": true, "url": "https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" } ] }, "public": true, "created_at": "2022-06-09T12:47:28Z" } ], "schema": { "type": "array", "items": { "title": "Event", "description": "Event", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": [ "string", "null" ] }, "actor": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "url" ] }, "org": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "payload": { "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] }, "comment": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] }, "pages": { "type": "array", "items": { "type": "object", "properties": { "page_name": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "action": { "type": "string" }, "sha": { "type": "string" }, "html_url": { "type": "string" } } } } } }, "public": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "type", "actor", "repo", "payload", "public", "created_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/events", "title": "List repository events", "category": "activity", "subcategory": "events", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": "22249084964", "type": "PushEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "push_id": 10115855396, "size": 1, "distinct_size": 1, "ref": "refs/heads/master", "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "before": "883efe034920928c47fe18598c01249d1a9fdabd", "commits": [ { "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "author": { "email": "octocat@github.com", "name": "Monalisa Octocat" }, "message": "commit", "distinct": true, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" } ] }, "public": true, "created_at": "2022-06-09T12:47:28Z" }, { "id": "22237752260", "type": "WatchEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "action": "started" }, "public": true, "created_at": "2022-06-08T23:29:25Z" } ], "schema": { "type": "array", "items": { "title": "Event", "description": "Event", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": [ "string", "null" ] }, "actor": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "url" ] }, "org": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "payload": { "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] }, "comment": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] }, "pages": { "type": "array", "items": { "type": "object", "properties": { "page_name": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "action": { "type": "string" }, "sha": { "type": "string" }, "html_url": { "type": "string" } } } } } }, "public": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "type", "actor", "repo", "payload", "public", "created_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/events", "title": "List events for the authenticated user", "category": "activity", "subcategory": "events", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": "22249084947", "type": "WatchEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "action": "started" }, "public": true, "created_at": "2022-06-09T12:47:28Z" }, { "id": "22249084964", "type": "PushEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "push_id": 10115855396, "size": 1, "distinct_size": 1, "ref": "refs/heads/master", "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "before": "883efe034920928c47fe18598c01249d1a9fdabd", "commits": [ { "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "author": { "email": "octocat@github.com", "name": "Monalisa Octocat" }, "message": "commit", "distinct": true, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" } ] }, "public": false, "created_at": "2022-06-07T07:50:26Z" } ], "schema": { "type": "array", "items": { "title": "Event", "description": "Event", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": [ "string", "null" ] }, "actor": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "url" ] }, "org": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "payload": { "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] }, "comment": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] }, "pages": { "type": "array", "items": { "type": "object", "properties": { "page_name": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "action": { "type": "string" }, "sha": { "type": "string" }, "html_url": { "type": "string" } } } } } }, "public": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "type", "actor", "repo", "payload", "public", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/events/orgs/{org}", "title": "List organization events for the authenticated user", "category": "activity", "subcategory": "events", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": "22249084964", "type": "PushEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "push_id": 10115855396, "size": 1, "distinct_size": 1, "ref": "refs/heads/master", "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "before": "883efe034920928c47fe18598c01249d1a9fdabd", "commits": [ { "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "author": { "email": "octocat@github.com", "name": "Monalisa Octocat" }, "message": "commit", "distinct": true, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" } ] }, "public": false, "created_at": "2022-06-09T12:47:28Z" }, { "id": "22196946742", "type": "CreateEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "ref": null, "ref_type": "repository", "master_branch": "master", "description": null, "pusher_type": "user" }, "public": false, "created_at": "2022-06-07T07:50:26Z", "org": { "id": 9919, "login": "github", "gravatar_id": "", "url": "https://api.github.com/orgs/github", "avatar_url": "https://avatars.githubusercontent.com/u/9919?" } } ], "schema": { "type": "array", "items": { "title": "Event", "description": "Event", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": [ "string", "null" ] }, "actor": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "url" ] }, "org": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "payload": { "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] }, "comment": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] }, "pages": { "type": "array", "items": { "type": "object", "properties": { "page_name": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "action": { "type": "string" }, "sha": { "type": "string" }, "html_url": { "type": "string" } } } } } }, "public": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "type", "actor", "repo", "payload", "public", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "This is the user's organization dashboard. You must be authenticated as the user to view this.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/events/public", "title": "List public events for a user", "category": "activity", "subcategory": "events", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": "22249084947", "type": "WatchEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "action": "started" }, "public": true, "created_at": "2022-06-09T12:47:28Z" }, { "id": "22249084964", "type": "PushEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "push_id": 10115855396, "size": 1, "distinct_size": 1, "ref": "refs/heads/master", "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "before": "883efe034920928c47fe18598c01249d1a9fdabd", "commits": [ { "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "author": { "email": "octocat@github.com", "name": "Monalisa Octocat" }, "message": "commit", "distinct": true, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" } ] }, "public": true, "created_at": "2022-06-08T23:29:25Z" } ], "schema": { "type": "array", "items": { "title": "Event", "description": "Event", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": [ "string", "null" ] }, "actor": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "url" ] }, "org": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "payload": { "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] }, "comment": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] }, "pages": { "type": "array", "items": { "type": "object", "properties": { "page_name": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "action": { "type": "string" }, "sha": { "type": "string" }, "html_url": { "type": "string" } } } } } }, "public": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "type", "actor", "repo", "payload", "public", "created_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/received_events", "title": "List events received by the authenticated user", "category": "activity", "subcategory": "events", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": "22249084964", "type": "PushEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "push_id": 10115855396, "size": 1, "distinct_size": 1, "ref": "refs/heads/master", "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "before": "883efe034920928c47fe18598c01249d1a9fdabd", "commits": [ { "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "author": { "email": "octocat@github.com", "name": "Monalisa Octocat" }, "message": "commit", "distinct": true, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" } ] }, "public": true, "created_at": "2022-06-09T12:47:28Z" }, { "id": "22196946742", "type": "CreateEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "ref": null, "ref_type": "repository", "master_branch": "master", "description": null, "pusher_type": "user" }, "public": false, "created_at": "2022-06-07T07:50:26Z", "org": { "id": 9919, "login": "github", "gravatar_id": "", "url": "https://api.github.com/orgs/github", "avatar_url": "https://avatars.githubusercontent.com/u/9919?" } } ], "schema": { "type": "array", "items": { "title": "Event", "description": "Event", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": [ "string", "null" ] }, "actor": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "url" ] }, "org": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "payload": { "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] }, "comment": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] }, "pages": { "type": "array", "items": { "type": "object", "properties": { "page_name": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "action": { "type": "string" }, "sha": { "type": "string" }, "html_url": { "type": "string" } } } } } }, "public": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "type", "actor", "repo", "payload", "public", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/received_events/public", "title": "List public events received by a user", "category": "activity", "subcategory": "events", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": "22249084964", "type": "PushEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "push_id": 10115855396, "size": 1, "distinct_size": 1, "ref": "refs/heads/master", "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "before": "883efe034920928c47fe18598c01249d1a9fdabd", "commits": [ { "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "author": { "email": "octocat@github.com", "name": "Monalisa Octocat" }, "message": "commit", "distinct": true, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" } ] }, "public": true, "created_at": "2022-06-09T12:47:28Z" }, { "id": "22196946742", "type": "CreateEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "ref": null, "ref_type": "repository", "master_branch": "master", "description": null, "pusher_type": "user" }, "public": false, "created_at": "2022-06-07T07:50:26Z", "org": { "id": 9919, "login": "github", "gravatar_id": "", "url": "https://api.github.com/orgs/github", "avatar_url": "https://avatars.githubusercontent.com/u/9919?" } } ], "schema": { "type": "array", "items": { "title": "Event", "description": "Event", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": [ "string", "null" ] }, "actor": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "url" ] }, "org": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "payload": { "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] }, "comment": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] }, "pages": { "type": "array", "items": { "type": "object", "properties": { "page_name": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "action": { "type": "string" }, "sha": { "type": "string" }, "html_url": { "type": "string" } } } } } }, "public": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "type", "actor", "repo", "payload", "public", "created_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ], "feeds": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/feeds", "title": "Get feeds", "category": "activity", "subcategory": "feeds", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "timeline_url": "https://github.com/timeline", "user_url": "https://github.com/{user}", "current_user_public_url": "https://github.com/octocat", "current_user_url": "https://github.com/octocat.private?token=abc123", "current_user_actor_url": "https://github.com/octocat.private.actor?token=abc123", "current_user_organization_url": "", "current_user_organization_urls": [ "https://github.com/organizations/github/octocat.private.atom?token=abc123" ], "security_advisories_url": "https://github.com/security-advisories", "_links": { "timeline": { "href": "https://github.com/timeline", "type": "application/atom+xml" }, "user": { "href": "https://github.com/{user}", "type": "application/atom+xml" }, "current_user_public": { "href": "https://github.com/octocat", "type": "application/atom+xml" }, "current_user": { "href": "https://github.com/octocat.private?token=abc123", "type": "application/atom+xml" }, "current_user_actor": { "href": "https://github.com/octocat.private.actor?token=abc123", "type": "application/atom+xml" }, "current_user_organization": { "href": "", "type": "" }, "current_user_organizations": [ { "href": "https://github.com/organizations/github/octocat.private.atom?token=abc123", "type": "application/atom+xml" } ], "security_advisories": { "href": "https://github.com/security-advisories", "type": "application/atom+xml" } } }, "schema": { "title": "Feed", "description": "Feed", "type": "object", "properties": { "timeline_url": { "type": "string", "examples": [ "https://github.com/timeline" ] }, "user_url": { "type": "string", "examples": [ "https://github.com/{user}" ] }, "current_user_public_url": { "type": "string", "examples": [ "https://github.com/octocat" ] }, "current_user_url": { "type": "string", "examples": [ "https://github.com/octocat.private?token=abc123" ] }, "current_user_actor_url": { "type": "string", "examples": [ "https://github.com/octocat.private.actor?token=abc123" ] }, "current_user_organization_url": { "type": "string", "examples": [ "https://github.com/octocat-org" ] }, "current_user_organization_urls": { "type": "array", "items": { "type": "string", "format": "uri" }, "examples": [ "https://github.com/organizations/github/octocat.private.atom?token=abc123" ] }, "security_advisories_url": { "type": "string", "examples": [ "https://github.com/security-advisories" ] }, "_links": { "type": "object", "properties": { "timeline": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "user": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "security_advisories": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "current_user": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "current_user_public": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "current_user_actor": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "current_user_organization": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "current_user_organizations": { "type": "array", "items": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] } } }, "required": [ "timeline", "user" ] } }, "required": [ "_links", "timeline_url", "user_url" ] } } } ], "previews": [], "descriptionHTML": "GitHub provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:
\n- \n
- Timeline: The GitHub global public timeline \n
- User: The public timeline for any user, using URI template \n
- Current user public: The public timeline for the authenticated user \n
- Current user: The private timeline for the authenticated user \n
- Current user actor: The private timeline for activity created by the authenticated user \n
- Current user organizations: The private timeline for the organizations the authenticated user is a member of. \n
- Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. \n
Note: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ], "notifications": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/notifications", "title": "List notifications for the authenticated user", "category": "activity", "subcategory": "notifications", "parameters": [ { "name": "all", "description": "If true, show notifications marked as read.
If true, only shows notifications in which the user is directly participating or mentioned.
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 50).
", "in": "query", "schema": { "type": "integer", "default": 50 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": "1", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "subject": { "title": "Greetings", "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123", "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123", "type": "Issue" }, "reason": "subscribed", "unread": true, "updated_at": "2014-11-07T22:01:45Z", "last_read_at": "2014-11-07T22:01:45Z", "url": "https://api.github.com/notifications/threads/1", "subscription_url": "https://api.github.com/notifications/threads/1/subscription" } ], "schema": { "type": "array", "items": { "title": "Thread", "description": "Thread", "type": "object", "properties": { "id": { "type": "string" }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "subject": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "latest_comment_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "title", "url", "latest_comment_url", "type" ] }, "reason": { "type": "string" }, "unread": { "type": "boolean" }, "updated_at": { "type": "string" }, "last_read_at": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "subscription_url": { "type": "string", "examples": [ "https://api.github.com/notifications/threads/2/subscription" ] } }, "required": [ "id", "unread", "reason", "updated_at", "last_read_at", "subject", "repository", "url", "subscription_url" ] } } } } ], "previews": [], "descriptionHTML": "List all notifications for the current user, sorted by most recently updated.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/notifications", "title": "Mark notifications as read", "category": "activity", "subcategory": "notifications", "parameters": [], "bodyParameters": [ { "type": "string", "name": "last_read_at", "in": "body", "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.
Whether the notification has been read.
" } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "last_read_at": "2022-06-10T00:00:00Z", "read": true } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response
", "example": { "message": "Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background." }, "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } ], "previews": [], "descriptionHTML": "Marks all notifications as \"read\" removes it from the default view on GitHub. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the List notifications for the authenticated user endpoint and pass the query parameter all=false.
Accepted
" }, { "httpStatusCode": "205", "description": "Reset Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/notifications/threads/{thread_id}", "title": "Get a thread", "category": "activity", "subcategory": "notifications", "parameters": [ { "name": "thread_id", "description": "The unique identifier of the pull request thread.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": "1", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "subject": { "title": "Greetings", "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123", "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123", "type": "Issue" }, "reason": "subscribed", "unread": true, "updated_at": "2014-11-07T22:01:45Z", "last_read_at": "2014-11-07T22:01:45Z", "url": "https://api.github.com/notifications/threads/1", "subscription_url": "https://api.github.com/notifications/threads/1/subscription" }, "schema": { "title": "Thread", "description": "Thread", "type": "object", "properties": { "id": { "type": "string" }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "subject": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "latest_comment_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "title", "url", "latest_comment_url", "type" ] }, "reason": { "type": "string" }, "unread": { "type": "boolean" }, "updated_at": { "type": "string" }, "last_read_at": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "subscription_url": { "type": "string", "examples": [ "https://api.github.com/notifications/threads/2/subscription" ] } }, "required": [ "id", "unread", "reason", "updated_at", "last_read_at", "subject", "repository", "url", "subscription_url" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/notifications/threads/{thread_id}", "title": "Mark a thread as read", "category": "activity", "subcategory": "notifications", "parameters": [ { "name": "thread_id", "description": "The unique identifier of the pull request thread.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "205", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" } }, "response": { "statusCode": "205", "description": "Reset Content
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "205", "description": "Reset Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/notifications/threads/{thread_id}/subscription", "title": "Get a thread subscription for the authenticated user", "category": "activity", "subcategory": "notifications", "parameters": [ { "name": "thread_id", "description": "The unique identifier of the pull request thread.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "subscribed": true, "ignored": false, "reason": null, "created_at": "2012-10-06T21:34:12Z", "url": "https://api.github.com/notifications/threads/1/subscription", "thread_url": "https://api.github.com/notifications/threads/1" }, "schema": { "title": "Thread Subscription", "description": "Thread Subscription", "type": "object", "properties": { "subscribed": { "type": "boolean", "examples": [ true ] }, "ignored": { "type": "boolean" }, "reason": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-06T21:34:12Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/notifications/threads/1/subscription" ] }, "thread_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/notifications/threads/1" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/1" ] } }, "required": [ "created_at", "ignored", "reason", "url", "subscribed" ] } } } ], "previews": [], "descriptionHTML": "This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.
\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were @mentioned, or manually subscribe to a thread.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/notifications/threads/{thread_id}/subscription", "title": "Set a thread subscription", "category": "activity", "subcategory": "notifications", "parameters": [ { "name": "thread_id", "description": "The unique identifier of the pull request thread.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "boolean", "name": "ignored", "in": "body", "description": "Whether to block all notifications from a thread.
" } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ignored": false }, "parameters": { "thread_id": "THREAD_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "subscribed": true, "ignored": false, "reason": null, "created_at": "2012-10-06T21:34:12Z", "url": "https://api.github.com/notifications/threads/1/subscription", "thread_url": "https://api.github.com/notifications/threads/1" }, "schema": { "title": "Thread Subscription", "description": "Thread Subscription", "type": "object", "properties": { "subscribed": { "type": "boolean", "examples": [ true ] }, "ignored": { "type": "boolean" }, "reason": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-06T21:34:12Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/notifications/threads/1/subscription" ] }, "thread_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/notifications/threads/1" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/1" ] } }, "required": [ "created_at", "ignored", "reason", "url", "subscribed" ] } } } ], "previews": [], "descriptionHTML": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an @mention.
\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.
\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/notifications/threads/{thread_id}/subscription", "title": "Delete a thread subscription", "category": "activity", "subcategory": "notifications", "parameters": [ { "name": "thread_id", "description": "The unique identifier of the pull request thread.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Mutes all future notifications for a conversation until you comment on the thread or get an @mention. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the Set a thread subscription endpoint and set ignore to true.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/notifications", "title": "List repository notifications for the authenticated user", "category": "activity", "subcategory": "notifications", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "all", "description": "If true, show notifications marked as read.
If true, only shows notifications in which the user is directly participating or mentioned.
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": "1", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "subject": { "title": "Greetings", "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123", "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123", "type": "Issue" }, "reason": "subscribed", "unread": true, "updated_at": "2014-11-07T22:01:45Z", "last_read_at": "2014-11-07T22:01:45Z", "url": "https://api.github.com/notifications/threads/1", "subscription_url": "https://api.github.com/notifications/threads/1/subscription" } ], "schema": { "type": "array", "items": { "title": "Thread", "description": "Thread", "type": "object", "properties": { "id": { "type": "string" }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "subject": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "latest_comment_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "title", "url", "latest_comment_url", "type" ] }, "reason": { "type": "string" }, "unread": { "type": "boolean" }, "updated_at": { "type": "string" }, "last_read_at": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "subscription_url": { "type": "string", "examples": [ "https://api.github.com/notifications/threads/2/subscription" ] } }, "required": [ "id", "unread", "reason", "updated_at", "last_read_at", "subject", "repository", "url", "subscription_url" ] } } } } ], "previews": [], "descriptionHTML": "List all notifications for the current user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/notifications", "title": "Mark repository notifications as read", "category": "activity", "subcategory": "notifications", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "last_read_at", "in": "body", "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.
Response
" } }, { "key": "205", "request": { "contentType": "application/json", "description": "Example 2: Status Code 205", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "205", "description": "Reset Content
" } } ], "previews": [], "descriptionHTML": "Marks all notifications in a repository as \"read\" removes them from the default view on GitHub. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the List repository notifications for the authenticated user endpoint and pass the query parameter all=false.
Accepted
" }, { "httpStatusCode": "205", "description": "Reset Content
" } ] } ], "starring": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/stargazers", "title": "List stargazers", "category": "activity", "subcategory": "starring", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default-response", "request": { "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Default response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "anyOf": [ { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, { "type": "array", "items": { "title": "Stargazer", "description": "Stargazer", "type": "object", "properties": { "starred_at": { "type": "string", "format": "date-time" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "starred_at", "user" ] } } ] } } }, { "key": "alternative-response-with-star-creation-timestamps", "request": { "description": "Example 2: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Alternative response with star creation timestamps
", "example": [ { "starred_at": "2011-01-16T19:06:43Z", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } ], "schema": { "anyOf": [ { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, { "type": "array", "items": { "title": "Stargazer", "description": "Stargazer", "type": "object", "properties": { "starred_at": { "type": "string", "format": "date-time" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "starred_at", "user" ] } } ] } } } ], "previews": [], "descriptionHTML": "Lists the people that have starred the repository.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/starred", "title": "List repositories starred by the authenticated user", "category": "activity", "subcategory": "starring", "parameters": [ { "name": "sort", "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default-response", "request": { "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Default response
", "example": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ], "schema": { "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } } } }, { "key": "alternative-response-with-star-creation-timestamps", "request": { "description": "Example 2: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/vnd.github.v3.star+json", "description": "Alternative response with star creation timestamps
", "example": [ { "starred_at": "2011-01-16T19:06:43Z", "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } } ], "schema": { "type": "array", "items": { "title": "Starred Repository", "description": "Starred Repository", "type": "object", "properties": { "starred_at": { "type": "string", "format": "date-time" }, "repo": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "required": [ "starred_at", "repo" ] } } } } ], "previews": [], "descriptionHTML": "Lists repositories the authenticated user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/starred/{owner}/{repo}", "title": "Check if a repository is starred by the authenticated user", "category": "activity", "subcategory": "starring", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response if this repository is starred by you
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "Response if this repository is starred by you
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Not Found if this repository is not starred by you
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/starred/{owner}/{repo}", "title": "Star a repository for the authenticated user", "category": "activity", "subcategory": "starring", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/starred/{owner}/{repo}", "title": "Unstar a repository for the authenticated user", "category": "activity", "subcategory": "starring", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/starred", "title": "List repositories starred by a user", "category": "activity", "subcategory": "starring", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sort", "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Default response
", "example": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ], "schema": { "anyOf": [ { "type": "array", "items": { "title": "Starred Repository", "description": "Starred Repository", "type": "object", "properties": { "starred_at": { "type": "string", "format": "date-time" }, "repo": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "required": [ "starred_at", "repo" ] } }, { "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } } ] } } } ], "previews": [], "descriptionHTML": "Lists repositories a user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
OK
" } ] } ], "watching": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscribers", "title": "List watchers", "category": "activity", "subcategory": "watching", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists the people watching the specified repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/subscription", "title": "Get a repository subscription", "category": "activity", "subcategory": "watching", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "if you subscribe to the repository
", "example": { "subscribed": true, "ignored": false, "reason": null, "created_at": "2012-10-06T21:34:12Z", "url": "https://api.github.com/repos/octocat/example/subscription", "repository_url": "https://api.github.com/repos/octocat/example" }, "schema": { "title": "Repository Invitation", "description": "Repository invitations let you manage who you collaborate with.", "type": "object", "properties": { "subscribed": { "description": "Determines if notifications should be received from this repository.", "type": "boolean", "examples": [ true ] }, "ignored": { "description": "Determines if all notifications should be blocked from this repository.", "type": "boolean" }, "reason": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-10-06T21:34:12Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/subscription" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] } }, "required": [ "created_at", "ignored", "reason", "subscribed", "url", "repository_url" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "if you subscribe to the repository
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Not Found if you don't subscribe to the repository
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/subscription", "title": "Set a repository subscription", "category": "activity", "subcategory": "watching", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "boolean", "name": "subscribed", "in": "body", "description": "Determines if notifications should be received from this repository.
" }, { "type": "boolean", "name": "ignored", "in": "body", "description": "Determines if all notifications should be blocked from this repository.
" } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "subscribed": true, "ignored": false, "reason": null, "created_at": "2012-10-06T21:34:12Z", "url": "https://api.github.com/repos/octocat/example/subscription", "repository_url": "https://api.github.com/repos/octocat/example" }, "schema": { "title": "Repository Invitation", "description": "Repository invitations let you manage who you collaborate with.", "type": "object", "properties": { "subscribed": { "description": "Determines if notifications should be received from this repository.", "type": "boolean", "examples": [ true ] }, "ignored": { "description": "Determines if all notifications should be blocked from this repository.", "type": "boolean" }, "reason": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-10-06T21:34:12Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/subscription" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] } }, "required": [ "created_at", "ignored", "reason", "subscribed", "url", "repository_url" ] } } } ], "previews": [], "descriptionHTML": "If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository's subscription completely.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/subscription", "title": "Delete a repository subscription", "category": "activity", "subcategory": "watching", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/subscriptions", "title": "List repositories watched by the authenticated user", "category": "activity", "subcategory": "watching", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": null } ], "schema": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists repositories the authenticated user is watching.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/subscriptions", "title": "List repositories watched by a user", "category": "activity", "subcategory": "watching", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": null } ], "schema": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists repositories a user is watching.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ] }, "apps": { "apps": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/app", "title": "Get the authenticated app", "category": "apps", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] }, "schema": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } } ], "previews": [], "descriptionHTML": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "apps" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/app-manifests/{code}/conversions", "title": "Create a GitHub App from a manifest", "category": "apps", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "code": "CODE" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "slug": "octoapp", "node_id": "MDxOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ], "client_id": "Iv1.8a61f9b3a7aba766", "client_secret": "1726be1638095a19edd134c77bde3aa2ece1e5d8", "webhook_secret": "e340154128314309424b7c8e90325147d99fdafa", "pem": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\n-----END RSA PRIVATE KEY-----\n" }, "schema": { "allOf": [ { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, { "type": "object", "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "webhook_secret": { "type": [ "string", "null" ] }, "pem": { "type": "string" } }, "required": [ "client_id", "client_secret", "webhook_secret", "pem" ], "additionalProperties": true } ] } } } ], "previews": [], "descriptionHTML": "Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App's id, pem (private key), and webhook_secret.
Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "apps" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/app/installations", "title": "List installations for the authenticated app", "category": "apps", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "since", "description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The permissions the installation has are included under the permissions key.
You must use a JWT to access this endpoint.
\nThe permissions the installation has are included under the permissions key.
The permissions the installation has are included under the permissions key.
The unique identifier of the installation.
", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "account": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "access_tokens_url": "https://api.github.com/installations/1/access_tokens", "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/github/settings/installations/1", "app_id": 1, "target_id": 1, "target_type": "Organization", "permissions": { "checks": "write", "metadata": "read", "contents": "read" }, "events": [ "push", "pull_request" ], "single_file_name": "config.yaml", "has_multiple_single_files": true, "single_file_paths": [ "config.yml", ".github/issue_TEMPLATE.md" ], "repository_selection": "selected", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "app_slug": "github-actions", "suspended_at": null, "suspended_by": null }, "schema": { "title": "Installation", "description": "Installation", "type": "object", "properties": { "id": { "description": "The ID of the installation.", "type": "integer", "examples": [ 1 ] }, "account": { "anyOf": [ { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise account", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/enterprises/octo-business" ] }, "website_url": { "description": "The enterprise's website URL.", "type": [ "string", "null" ], "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the enterprise.", "type": "string", "examples": [ "Octo Business" ] }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "examples": [ "octo-business" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2019-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2019-01-26T19:14:43Z" ] }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ], "type": [ "null", "object" ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "access_tokens_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/installations/1/access_tokens" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/installation/repositories" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/organizations/github/settings/installations/1" ] }, "app_id": { "type": "integer", "examples": [ 1 ] }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" }, "target_type": { "type": "string", "examples": [ "Organization" ] }, "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user-to-server access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", "enum": [ "read", "write" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "events": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "single_file_name": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "has_multiple_single_files": { "type": "boolean", "examples": [ true ] }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "examples": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "app_slug": { "type": "string", "examples": [ "github-actions" ] }, "suspended_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "contact_email": { "type": [ "string", "null" ], "examples": [ "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] } }, "required": [ "id", "app_id", "app_slug", "target_id", "target_type", "single_file_name", "repository_selection", "access_tokens_url", "html_url", "repositories_url", "events", "account", "permissions", "created_at", "updated_at", "suspended_by", "suspended_at" ] } } } ], "previews": [], "descriptionHTML": "Enables an authenticated GitHub App to find an installation's information using the installation id.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "apps" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/app/installations/{installation_id}", "title": "Delete an installation for the authenticated app", "category": "apps", "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.
", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "apps" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/app/installations/{installation_id}/access_tokens", "title": "Create an installation access token for an app", "category": "apps", "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.
", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "bodyParameters": [ { "type": "array of strings", "name": "repositories", "in": "body", "description": "List of repository names that the token should have access to
" }, { "type": "array of integers", "name": "repository_ids", "in": "body", "description": "List of repository IDs that the token should have access to
" }, { "type": "object", "name": "permissions", "in": "body", "description": "The permissions granted to the user-to-server access token.
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "The level of permission to grant the access token for checks on code.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "The level of permission to grant the access token for deployments and deployment statuses.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "The level of permission to grant the access token for managing repository environments.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "The level of permission to grant the access token for packages published to GitHub Packages.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.
", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "The level of permission to grant the access token to manage repository secrets.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "The level of permission to grant the access token to manage just a single file.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "The level of permission to grant the access token for commit statuses.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "The level of permission to grant the access token to manage Dependabot alerts.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.
", "enum": [ "write" ] }, { "type": "string", "name": "members", "description": "The level of permission to grant the access token for organization teams and members.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "The level of permission to grant the access token to manage access to an organization.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_custom_roles", "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "The level of permission to grant the access token for viewing an organization's plan.
", "enum": [ "read" ] }, { "type": "string", "name": "organization_projects", "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).
", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_packages", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_secrets", "description": "The level of permission to grant the access token to manage organization secrets.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "The level of permission to grant the access token to manage team discussions and related comments.
", "enum": [ "read", "write" ] } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository": "Hello-World", "permissions": { "issues": "write", "contents": "read" } }, "parameters": { "installation_id": 1 } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a", "expires_at": "2016-07-11T22:14:10Z", "permissions": { "issues": "write", "contents": "read" }, "repository_selection": "selected", "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ] }, "schema": { "title": "Installation Token", "description": "Authentication token for a GitHub App installed on a user or org.", "type": "object", "properties": { "token": { "type": "string" }, "expires_at": { "type": "string" }, "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user-to-server access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", "enum": [ "read", "write" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "repository_selection": { "type": "string", "enum": [ "all", "selected" ] }, "repositories": { "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "single_file": { "type": "string", "examples": [ "README.md" ] }, "has_multiple_single_files": { "type": "boolean", "examples": [ true ] }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "examples": [ "config.yml", ".github/issue_TEMPLATE.md" ] } }, "required": [ "token", "expires_at" ] } } } ], "previews": [], "descriptionHTML": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.
You must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "apps" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/app/installations/{installation_id}/suspended", "title": "Suspend an app installation", "category": "apps", "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.
", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "apps" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/app/installations/{installation_id}/suspended", "title": "Unsuspend an app installation", "category": "apps", "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.
", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes a GitHub App installation suspension.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "apps" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/apps/{app_slug}", "title": "Get an app", "category": "apps", "parameters": [ { "name": "app_slug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "app_slug": "APP_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] }, "schema": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } } ], "previews": [], "descriptionHTML": "Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "apps" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/installation", "title": "Get an organization installation for the authenticated app", "category": "apps", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "account": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/orgs/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "repository_selection": "all", "access_tokens_url": "https://api.github.com/installations/1/access_tokens", "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/github/settings/installations/1", "app_id": 1, "target_id": 1, "target_type": "Organization", "permissions": { "checks": "write", "metadata": "read", "contents": "read" }, "events": [ "push", "pull_request" ], "created_at": "2018-02-09T20:51:14Z", "updated_at": "2018-02-09T20:51:14Z", "single_file_name": "config.yml", "has_multiple_single_files": true, "single_file_paths": [ "config.yml", ".github/issue_TEMPLATE.md" ], "app_slug": "github-actions", "suspended_at": null, "suspended_by": null }, "schema": { "title": "Installation", "description": "Installation", "type": "object", "properties": { "id": { "description": "The ID of the installation.", "type": "integer", "examples": [ 1 ] }, "account": { "anyOf": [ { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise account", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/enterprises/octo-business" ] }, "website_url": { "description": "The enterprise's website URL.", "type": [ "string", "null" ], "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the enterprise.", "type": "string", "examples": [ "Octo Business" ] }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "examples": [ "octo-business" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2019-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2019-01-26T19:14:43Z" ] }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ], "type": [ "null", "object" ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "access_tokens_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/installations/1/access_tokens" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/installation/repositories" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/organizations/github/settings/installations/1" ] }, "app_id": { "type": "integer", "examples": [ 1 ] }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" }, "target_type": { "type": "string", "examples": [ "Organization" ] }, "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user-to-server access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", "enum": [ "read", "write" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "events": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "single_file_name": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "has_multiple_single_files": { "type": "boolean", "examples": [ true ] }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "examples": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "app_slug": { "type": "string", "examples": [ "github-actions" ] }, "suspended_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "contact_email": { "type": [ "string", "null" ], "examples": [ "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] } }, "required": [ "id", "app_id", "app_slug", "target_id", "target_type", "single_file_name", "repository_selection", "access_tokens_url", "html_url", "repositories_url", "events", "account", "permissions", "created_at", "updated_at", "suspended_by", "suspended_at" ] } } } ], "previews": [], "descriptionHTML": "Enables an authenticated GitHub App to find the organization's installation information.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "apps" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/installation", "title": "Get a repository installation for the authenticated app", "category": "apps", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "account": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/orgs/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "repository_selection": "all", "access_tokens_url": "https://api.github.com/installations/1/access_tokens", "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/github/settings/installations/1", "app_id": 1, "target_id": 1, "target_type": "Organization", "permissions": { "checks": "write", "metadata": "read", "contents": "read" }, "events": [ "push", "pull_request" ], "created_at": "2018-02-09T20:51:14Z", "updated_at": "2018-02-09T20:51:14Z", "single_file_name": "config.yml", "has_multiple_single_files": true, "single_file_paths": [ "config.yml", ".github/issue_TEMPLATE.md" ], "app_slug": "github-actions", "suspended_at": null, "suspended_by": null }, "schema": { "title": "Installation", "description": "Installation", "type": "object", "properties": { "id": { "description": "The ID of the installation.", "type": "integer", "examples": [ 1 ] }, "account": { "anyOf": [ { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise account", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/enterprises/octo-business" ] }, "website_url": { "description": "The enterprise's website URL.", "type": [ "string", "null" ], "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the enterprise.", "type": "string", "examples": [ "Octo Business" ] }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "examples": [ "octo-business" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2019-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2019-01-26T19:14:43Z" ] }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ], "type": [ "null", "object" ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "access_tokens_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/installations/1/access_tokens" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/installation/repositories" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/organizations/github/settings/installations/1" ] }, "app_id": { "type": "integer", "examples": [ 1 ] }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" }, "target_type": { "type": "string", "examples": [ "Organization" ] }, "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user-to-server access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", "enum": [ "read", "write" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "events": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "single_file_name": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "has_multiple_single_files": { "type": "boolean", "examples": [ true ] }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "examples": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "app_slug": { "type": "string", "examples": [ "github-actions" ] }, "suspended_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "contact_email": { "type": [ "string", "null" ], "examples": [ "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] } }, "required": [ "id", "app_id", "app_slug", "target_id", "target_type", "single_file_name", "repository_selection", "access_tokens_url", "html_url", "repositories_url", "events", "account", "permissions", "created_at", "updated_at", "suspended_by", "suspended_at" ] } } } ], "previews": [], "descriptionHTML": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "301", "description": "Moved permanently
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "apps" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/installation", "title": "Get a user installation for the authenticated app", "category": "apps", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "account": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/orgs/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "repository_selection": "all", "access_tokens_url": "https://api.github.com/installations/1/access_tokens", "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/github/settings/installations/1", "app_id": 1, "target_id": 1, "target_type": "Organization", "permissions": { "checks": "write", "metadata": "read", "contents": "read" }, "events": [ "push", "pull_request" ], "created_at": "2018-02-09T20:51:14Z", "updated_at": "2018-02-09T20:51:14Z", "single_file_name": "config.yml", "has_multiple_single_files": true, "single_file_paths": [ "config.yml", ".github/issue_TEMPLATE.md" ], "app_slug": "github-actions", "suspended_at": null, "suspended_by": null }, "schema": { "title": "Installation", "description": "Installation", "type": "object", "properties": { "id": { "description": "The ID of the installation.", "type": "integer", "examples": [ 1 ] }, "account": { "anyOf": [ { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise account", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/enterprises/octo-business" ] }, "website_url": { "description": "The enterprise's website URL.", "type": [ "string", "null" ], "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the enterprise.", "type": "string", "examples": [ "Octo Business" ] }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "examples": [ "octo-business" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2019-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2019-01-26T19:14:43Z" ] }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ], "type": [ "null", "object" ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "access_tokens_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/installations/1/access_tokens" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/installation/repositories" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/organizations/github/settings/installations/1" ] }, "app_id": { "type": "integer", "examples": [ 1 ] }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" }, "target_type": { "type": "string", "examples": [ "Organization" ] }, "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user-to-server access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", "enum": [ "read", "write" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "events": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "single_file_name": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "has_multiple_single_files": { "type": "boolean", "examples": [ true ] }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "examples": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "app_slug": { "type": "string", "examples": [ "github-actions" ] }, "suspended_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "contact_email": { "type": [ "string", "null" ], "examples": [ "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] } }, "required": [ "id", "app_id", "app_slug", "target_id", "target_type", "single_file_name", "repository_selection", "access_tokens_url", "html_url", "repositories_url", "events", "account", "permissions", "created_at", "updated_at", "suspended_by", "suspended_at" ] } } } ], "previews": [], "descriptionHTML": "Enables an authenticated GitHub App to find the user’s installation information.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "apps" } ], "installations": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/installation/repositories", "title": "List repositories accessible to the app installation", "category": "apps", "subcategory": "installations", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ] }, "schema": { "type": "object", "required": [ "total_count", "repositories" ], "properties": { "total_count": { "type": "integer" }, "repositories": { "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "repository_selection": { "type": "string", "examples": [ "selected" ] } } } } } ], "previews": [], "descriptionHTML": "List repositories that an app installation can access.
\nYou must use an installation access token to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/installation/token", "title": "Revoke an installation access token", "category": "apps", "subcategory": "installations", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.
\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"Create an installation access token for an app\" endpoint.
\nYou must use an installation access token to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/installations", "title": "List app installations accessible to the user access token", "category": "apps", "subcategory": "installations", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "You can find the permissions for the installation under the permissions key.
Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.
You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.
\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
\nYou can find the permissions for the installation under the permissions key.
You can find the permissions for the installation under the permissions key.
Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/installations/{installation_id}/repositories", "title": "List repositories accessible to the user access token", "category": "apps", "subcategory": "installations", "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.
", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "The access the user has to each repository is included in the hash under the permissions key.
List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.
The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
\nYou must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.
\nThe access the user has to each repository is included in the hash under the permissions key.
The access the user has to each repository is included in the hash under the permissions key.
Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", "title": "Add a repository to an app installation", "category": "apps", "subcategory": "installations", "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.
", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } }, { "name": "repository_id", "description": "The unique identifier of the repository.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Add a single repository to an installation. The authenticated user must have admin access to the repository.
\nYou must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}", "title": "Remove a repository from an app installation", "category": "apps", "subcategory": "installations", "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.
", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } }, { "name": "repository_id", "description": "The unique identifier of the repository.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.
\nYou must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "marketplace": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/marketplace_listing/accounts/{account_id}", "title": "Get a subscription plan for an account", "category": "apps", "subcategory": "marketplace", "parameters": [ { "name": "account_id", "description": "account_id parameter
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "account_id": "ACCOUNT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/orgs/github", "type": "Organization", "id": 4, "login": "github", "organization_billing_email": "billing@github.com", "email": "billing@github.com", "marketplace_pending_change": { "effective_date": "2017-11-11T00:00:00Z", "unit_count": null, "id": 77, "plan": { "url": "https://api.github.com/marketplace_listing/plans/1111", "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts", "id": 1111, "number": 2, "name": "Startup", "description": "A professional-grade CI solution", "monthly_price_in_cents": 699, "yearly_price_in_cents": 7870, "price_model": "flat-rate", "has_free_trial": true, "state": "published", "unit_name": null, "bullets": [ "Up to 10 private repositories", "3 concurrent builds" ] } }, "marketplace_purchase": { "billing_cycle": "monthly", "next_billing_date": "2017-11-11T00:00:00Z", "unit_count": null, "on_free_trial": true, "free_trial_ends_on": "2017-11-11T00:00:00Z", "updated_at": "2017-11-02T01:12:12Z", "plan": { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "flat-rate", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } } }, "schema": { "title": "Marketplace Purchase", "description": "Marketplace Purchase", "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" }, "id": { "type": "integer" }, "login": { "type": "string" }, "organization_billing_email": { "type": "string" }, "email": { "type": [ "string", "null" ] }, "marketplace_pending_change": { "type": [ "object", "null" ], "properties": { "is_installed": { "type": "boolean" }, "effective_date": { "type": "string" }, "unit_count": { "type": [ "integer", "null" ] }, "id": { "type": "integer" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313" ] }, "accounts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313/accounts" ] }, "id": { "type": "integer", "examples": [ 1313 ] }, "number": { "type": "integer", "examples": [ 3 ] }, "name": { "type": "string", "examples": [ "Pro" ] }, "description": { "type": "string", "examples": [ "A professional-grade CI solution" ] }, "monthly_price_in_cents": { "type": "integer", "examples": [ 1099 ] }, "yearly_price_in_cents": { "type": "integer", "examples": [ 11870 ] }, "price_model": { "type": "string", "examples": [ "flat-rate" ] }, "has_free_trial": { "type": "boolean", "examples": [ true ] }, "unit_name": { "type": [ "string", "null" ] }, "state": { "type": "string", "examples": [ "published" ] }, "bullets": { "type": "array", "items": { "type": "string" }, "examples": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } }, "marketplace_purchase": { "type": "object", "properties": { "billing_cycle": { "type": "string" }, "next_billing_date": { "type": [ "string", "null" ] }, "is_installed": { "type": "boolean" }, "unit_count": { "type": [ "integer", "null" ] }, "on_free_trial": { "type": "boolean" }, "free_trial_ends_on": { "type": [ "string", "null" ] }, "updated_at": { "type": "string" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313" ] }, "accounts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313/accounts" ] }, "id": { "type": "integer", "examples": [ 1313 ] }, "number": { "type": "integer", "examples": [ 3 ] }, "name": { "type": "string", "examples": [ "Pro" ] }, "description": { "type": "string", "examples": [ "A professional-grade CI solution" ] }, "monthly_price_in_cents": { "type": "integer", "examples": [ 1099 ] }, "yearly_price_in_cents": { "type": "integer", "examples": [ 11870 ] }, "price_model": { "type": "string", "examples": [ "flat-rate" ] }, "has_free_trial": { "type": "boolean", "examples": [ true ] }, "unit_name": { "type": [ "string", "null" ] }, "state": { "type": "string", "examples": [ "published" ] }, "bullets": { "type": "array", "items": { "type": "string" }, "examples": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } } }, "required": [ "url", "id", "type", "login", "marketplace_purchase" ] } } } ], "previews": [], "descriptionHTML": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
\nGitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "404", "description": "Not Found when the account has not purchased the listing
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/marketplace_listing/plans", "title": "List plans", "category": "apps", "subcategory": "marketplace", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "flat-rate", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } ], "schema": { "type": "array", "items": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313" ] }, "accounts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313/accounts" ] }, "id": { "type": "integer", "examples": [ 1313 ] }, "number": { "type": "integer", "examples": [ 3 ] }, "name": { "type": "string", "examples": [ "Pro" ] }, "description": { "type": "string", "examples": [ "A professional-grade CI solution" ] }, "monthly_price_in_cents": { "type": "integer", "examples": [ 1099 ] }, "yearly_price_in_cents": { "type": "integer", "examples": [ 11870 ] }, "price_model": { "type": "string", "examples": [ "flat-rate" ] }, "has_free_trial": { "type": "boolean", "examples": [ true ] }, "unit_name": { "type": [ "string", "null" ] }, "state": { "type": "string", "examples": [ "published" ] }, "bullets": { "type": "array", "items": { "type": "string" }, "examples": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } } } ], "previews": [], "descriptionHTML": "Lists all plans that are part of your GitHub Marketplace listing.
\nGitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/marketplace_listing/plans/{plan_id}/accounts", "title": "List accounts for a plan", "category": "apps", "subcategory": "marketplace", "parameters": [ { "name": "plan_id", "description": "The unique identifier of the plan.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "sort", "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
To return the oldest accounts first, set to asc. Ignored without the sort parameter.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "plan_id": "PLAN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/orgs/github", "type": "Organization", "id": 4, "login": "github", "organization_billing_email": "billing@github.com", "marketplace_pending_change": { "effective_date": "2017-11-11T00:00:00Z", "unit_count": null, "id": 77, "plan": { "url": "https://api.github.com/marketplace_listing/plans/1111", "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts", "id": 1111, "number": 2, "name": "Startup", "description": "A professional-grade CI solution", "monthly_price_in_cents": 699, "yearly_price_in_cents": 7870, "price_model": "flat-rate", "has_free_trial": true, "state": "published", "unit_name": null, "bullets": [ "Up to 10 private repositories", "3 concurrent builds" ] } }, "marketplace_purchase": { "billing_cycle": "monthly", "next_billing_date": "2017-11-11T00:00:00Z", "unit_count": null, "on_free_trial": true, "free_trial_ends_on": "2017-11-11T00:00:00Z", "updated_at": "2017-11-02T01:12:12Z", "plan": { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "flat-rate", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } } } ], "schema": { "type": "array", "items": { "title": "Marketplace Purchase", "description": "Marketplace Purchase", "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" }, "id": { "type": "integer" }, "login": { "type": "string" }, "organization_billing_email": { "type": "string" }, "email": { "type": [ "string", "null" ] }, "marketplace_pending_change": { "type": [ "object", "null" ], "properties": { "is_installed": { "type": "boolean" }, "effective_date": { "type": "string" }, "unit_count": { "type": [ "integer", "null" ] }, "id": { "type": "integer" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313" ] }, "accounts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313/accounts" ] }, "id": { "type": "integer", "examples": [ 1313 ] }, "number": { "type": "integer", "examples": [ 3 ] }, "name": { "type": "string", "examples": [ "Pro" ] }, "description": { "type": "string", "examples": [ "A professional-grade CI solution" ] }, "monthly_price_in_cents": { "type": "integer", "examples": [ 1099 ] }, "yearly_price_in_cents": { "type": "integer", "examples": [ 11870 ] }, "price_model": { "type": "string", "examples": [ "flat-rate" ] }, "has_free_trial": { "type": "boolean", "examples": [ true ] }, "unit_name": { "type": [ "string", "null" ] }, "state": { "type": "string", "examples": [ "published" ] }, "bullets": { "type": "array", "items": { "type": "string" }, "examples": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } }, "marketplace_purchase": { "type": "object", "properties": { "billing_cycle": { "type": "string" }, "next_billing_date": { "type": [ "string", "null" ] }, "is_installed": { "type": "boolean" }, "unit_count": { "type": [ "integer", "null" ] }, "on_free_trial": { "type": "boolean" }, "free_trial_ends_on": { "type": [ "string", "null" ] }, "updated_at": { "type": "string" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313" ] }, "accounts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313/accounts" ] }, "id": { "type": "integer", "examples": [ 1313 ] }, "number": { "type": "integer", "examples": [ 3 ] }, "name": { "type": "string", "examples": [ "Pro" ] }, "description": { "type": "string", "examples": [ "A professional-grade CI solution" ] }, "monthly_price_in_cents": { "type": "integer", "examples": [ 1099 ] }, "yearly_price_in_cents": { "type": "integer", "examples": [ 11870 ] }, "price_model": { "type": "string", "examples": [ "flat-rate" ] }, "has_free_trial": { "type": "boolean", "examples": [ true ] }, "unit_name": { "type": [ "string", "null" ] }, "state": { "type": "string", "examples": [ "published" ] }, "bullets": { "type": "array", "items": { "type": "string" }, "examples": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } } }, "required": [ "url", "id", "type", "login", "marketplace_purchase" ] } } } } ], "previews": [], "descriptionHTML": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
\nGitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/marketplace_listing/stubbed/accounts/{account_id}", "title": "Get a subscription plan for an account (stubbed)", "category": "apps", "subcategory": "marketplace", "parameters": [ { "name": "account_id", "description": "account_id parameter
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "account_id": "ACCOUNT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/orgs/github", "type": "Organization", "id": 4, "login": "github", "organization_billing_email": "billing@github.com", "email": "billing@github.com", "marketplace_pending_change": { "effective_date": "2017-11-11T00:00:00Z", "unit_count": null, "id": 77, "plan": { "url": "https://api.github.com/marketplace_listing/plans/1111", "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts", "id": 1111, "number": 2, "name": "Startup", "description": "A professional-grade CI solution", "monthly_price_in_cents": 699, "yearly_price_in_cents": 7870, "price_model": "flat-rate", "has_free_trial": true, "state": "published", "unit_name": null, "bullets": [ "Up to 10 private repositories", "3 concurrent builds" ] } }, "marketplace_purchase": { "billing_cycle": "monthly", "next_billing_date": "2017-11-11T00:00:00Z", "unit_count": null, "on_free_trial": true, "free_trial_ends_on": "2017-11-11T00:00:00Z", "updated_at": "2017-11-02T01:12:12Z", "plan": { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "flat-rate", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } } }, "schema": { "title": "Marketplace Purchase", "description": "Marketplace Purchase", "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" }, "id": { "type": "integer" }, "login": { "type": "string" }, "organization_billing_email": { "type": "string" }, "email": { "type": [ "string", "null" ] }, "marketplace_pending_change": { "type": [ "object", "null" ], "properties": { "is_installed": { "type": "boolean" }, "effective_date": { "type": "string" }, "unit_count": { "type": [ "integer", "null" ] }, "id": { "type": "integer" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313" ] }, "accounts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313/accounts" ] }, "id": { "type": "integer", "examples": [ 1313 ] }, "number": { "type": "integer", "examples": [ 3 ] }, "name": { "type": "string", "examples": [ "Pro" ] }, "description": { "type": "string", "examples": [ "A professional-grade CI solution" ] }, "monthly_price_in_cents": { "type": "integer", "examples": [ 1099 ] }, "yearly_price_in_cents": { "type": "integer", "examples": [ 11870 ] }, "price_model": { "type": "string", "examples": [ "flat-rate" ] }, "has_free_trial": { "type": "boolean", "examples": [ true ] }, "unit_name": { "type": [ "string", "null" ] }, "state": { "type": "string", "examples": [ "published" ] }, "bullets": { "type": "array", "items": { "type": "string" }, "examples": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } }, "marketplace_purchase": { "type": "object", "properties": { "billing_cycle": { "type": "string" }, "next_billing_date": { "type": [ "string", "null" ] }, "is_installed": { "type": "boolean" }, "unit_count": { "type": [ "integer", "null" ] }, "on_free_trial": { "type": "boolean" }, "free_trial_ends_on": { "type": [ "string", "null" ] }, "updated_at": { "type": "string" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313" ] }, "accounts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313/accounts" ] }, "id": { "type": "integer", "examples": [ 1313 ] }, "number": { "type": "integer", "examples": [ 3 ] }, "name": { "type": "string", "examples": [ "Pro" ] }, "description": { "type": "string", "examples": [ "A professional-grade CI solution" ] }, "monthly_price_in_cents": { "type": "integer", "examples": [ 1099 ] }, "yearly_price_in_cents": { "type": "integer", "examples": [ 11870 ] }, "price_model": { "type": "string", "examples": [ "flat-rate" ] }, "has_free_trial": { "type": "boolean", "examples": [ true ] }, "unit_name": { "type": [ "string", "null" ] }, "state": { "type": "string", "examples": [ "published" ] }, "bullets": { "type": "array", "items": { "type": "string" }, "examples": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } } }, "required": [ "url", "id", "type", "login", "marketplace_purchase" ] } } } ], "previews": [], "descriptionHTML": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
\nGitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "404", "description": "Not Found when the account has not purchased the listing
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/marketplace_listing/stubbed/plans", "title": "List plans (stubbed)", "category": "apps", "subcategory": "marketplace", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "flat-rate", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } ], "schema": { "type": "array", "items": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313" ] }, "accounts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313/accounts" ] }, "id": { "type": "integer", "examples": [ 1313 ] }, "number": { "type": "integer", "examples": [ 3 ] }, "name": { "type": "string", "examples": [ "Pro" ] }, "description": { "type": "string", "examples": [ "A professional-grade CI solution" ] }, "monthly_price_in_cents": { "type": "integer", "examples": [ 1099 ] }, "yearly_price_in_cents": { "type": "integer", "examples": [ 11870 ] }, "price_model": { "type": "string", "examples": [ "flat-rate" ] }, "has_free_trial": { "type": "boolean", "examples": [ true ] }, "unit_name": { "type": [ "string", "null" ] }, "state": { "type": "string", "examples": [ "published" ] }, "bullets": { "type": "array", "items": { "type": "string" }, "examples": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } } } ], "previews": [], "descriptionHTML": "Lists all plans that are part of your GitHub Marketplace listing.
\nGitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/marketplace_listing/stubbed/plans/{plan_id}/accounts", "title": "List accounts for a plan (stubbed)", "category": "apps", "subcategory": "marketplace", "parameters": [ { "name": "plan_id", "description": "The unique identifier of the plan.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "sort", "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
To return the oldest accounts first, set to asc. Ignored without the sort parameter.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "plan_id": "PLAN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/orgs/github", "type": "Organization", "id": 4, "login": "github", "organization_billing_email": "billing@github.com", "marketplace_pending_change": { "effective_date": "2017-11-11T00:00:00Z", "unit_count": null, "id": 77, "plan": { "url": "https://api.github.com/marketplace_listing/plans/1111", "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts", "id": 1111, "number": 2, "name": "Startup", "description": "A professional-grade CI solution", "monthly_price_in_cents": 699, "yearly_price_in_cents": 7870, "price_model": "flat-rate", "has_free_trial": true, "state": "published", "unit_name": null, "bullets": [ "Up to 10 private repositories", "3 concurrent builds" ] } }, "marketplace_purchase": { "billing_cycle": "monthly", "next_billing_date": "2017-11-11T00:00:00Z", "unit_count": null, "on_free_trial": true, "free_trial_ends_on": "2017-11-11T00:00:00Z", "updated_at": "2017-11-02T01:12:12Z", "plan": { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "flat-rate", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } } } ], "schema": { "type": "array", "items": { "title": "Marketplace Purchase", "description": "Marketplace Purchase", "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" }, "id": { "type": "integer" }, "login": { "type": "string" }, "organization_billing_email": { "type": "string" }, "email": { "type": [ "string", "null" ] }, "marketplace_pending_change": { "type": [ "object", "null" ], "properties": { "is_installed": { "type": "boolean" }, "effective_date": { "type": "string" }, "unit_count": { "type": [ "integer", "null" ] }, "id": { "type": "integer" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313" ] }, "accounts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313/accounts" ] }, "id": { "type": "integer", "examples": [ 1313 ] }, "number": { "type": "integer", "examples": [ 3 ] }, "name": { "type": "string", "examples": [ "Pro" ] }, "description": { "type": "string", "examples": [ "A professional-grade CI solution" ] }, "monthly_price_in_cents": { "type": "integer", "examples": [ 1099 ] }, "yearly_price_in_cents": { "type": "integer", "examples": [ 11870 ] }, "price_model": { "type": "string", "examples": [ "flat-rate" ] }, "has_free_trial": { "type": "boolean", "examples": [ true ] }, "unit_name": { "type": [ "string", "null" ] }, "state": { "type": "string", "examples": [ "published" ] }, "bullets": { "type": "array", "items": { "type": "string" }, "examples": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } }, "marketplace_purchase": { "type": "object", "properties": { "billing_cycle": { "type": "string" }, "next_billing_date": { "type": [ "string", "null" ] }, "is_installed": { "type": "boolean" }, "unit_count": { "type": [ "integer", "null" ] }, "on_free_trial": { "type": "boolean" }, "free_trial_ends_on": { "type": [ "string", "null" ] }, "updated_at": { "type": "string" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313" ] }, "accounts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313/accounts" ] }, "id": { "type": "integer", "examples": [ 1313 ] }, "number": { "type": "integer", "examples": [ 3 ] }, "name": { "type": "string", "examples": [ "Pro" ] }, "description": { "type": "string", "examples": [ "A professional-grade CI solution" ] }, "monthly_price_in_cents": { "type": "integer", "examples": [ 1099 ] }, "yearly_price_in_cents": { "type": "integer", "examples": [ 11870 ] }, "price_model": { "type": "string", "examples": [ "flat-rate" ] }, "has_free_trial": { "type": "boolean", "examples": [ true ] }, "unit_name": { "type": [ "string", "null" ] }, "state": { "type": "string", "examples": [ "published" ] }, "bullets": { "type": "array", "items": { "type": "string" }, "examples": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } } }, "required": [ "url", "id", "type", "login", "marketplace_purchase" ] } } } } ], "previews": [], "descriptionHTML": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
\nGitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/marketplace_purchases", "title": "List subscriptions for the authenticated user", "category": "apps", "subcategory": "marketplace", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "billing_cycle": "monthly", "next_billing_date": "2017-11-11T00:00:00Z", "unit_count": null, "on_free_trial": true, "free_trial_ends_on": "2017-11-11T00:00:00Z", "updated_at": "2017-11-02T01:12:12Z", "account": { "login": "github", "id": 4, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "email": null, "organization_billing_email": "billing@github.com", "type": "Organization" }, "plan": { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "flat-rate", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } } ], "schema": { "type": "array", "items": { "title": "User Marketplace Purchase", "description": "User Marketplace Purchase", "type": "object", "properties": { "billing_cycle": { "type": "string", "examples": [ "monthly" ] }, "next_billing_date": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2017-11-11T00:00:00Z" ] }, "unit_count": { "type": [ "integer", "null" ] }, "on_free_trial": { "type": "boolean", "examples": [ true ] }, "free_trial_ends_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2017-11-11T00:00:00Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2017-11-02T01:12:12Z" ] }, "account": { "title": "Marketplace Account", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "type": { "type": "string" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "email": { "type": [ "string", "null" ], "format": "email" }, "organization_billing_email": { "type": [ "string", "null" ], "format": "email" } }, "required": [ "url", "id", "type", "login" ] }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313" ] }, "accounts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313/accounts" ] }, "id": { "type": "integer", "examples": [ 1313 ] }, "number": { "type": "integer", "examples": [ 3 ] }, "name": { "type": "string", "examples": [ "Pro" ] }, "description": { "type": "string", "examples": [ "A professional-grade CI solution" ] }, "monthly_price_in_cents": { "type": "integer", "examples": [ 1099 ] }, "yearly_price_in_cents": { "type": "integer", "examples": [ 11870 ] }, "price_model": { "type": "string", "examples": [ "flat-rate" ] }, "has_free_trial": { "type": "boolean", "examples": [ true ] }, "unit_name": { "type": [ "string", "null" ] }, "state": { "type": "string", "examples": [ "published" ] }, "bullets": { "type": "array", "items": { "type": "string" }, "examples": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } }, "required": [ "billing_cycle", "next_billing_date", "unit_count", "updated_at", "on_free_trial", "free_trial_ends_on", "account", "plan" ] } } } } ], "previews": [], "descriptionHTML": "Lists the active subscriptions for the authenticated user. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/marketplace_purchases/stubbed", "title": "List subscriptions for the authenticated user (stubbed)", "category": "apps", "subcategory": "marketplace", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "billing_cycle": "monthly", "next_billing_date": "2017-11-11T00:00:00Z", "unit_count": null, "on_free_trial": true, "free_trial_ends_on": "2017-11-11T00:00:00Z", "updated_at": "2017-11-02T01:12:12Z", "account": { "login": "github", "id": 4, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "email": null, "organization_billing_email": "billing@github.com", "type": "Organization" }, "plan": { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "flat-rate", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } } ], "schema": { "type": "array", "items": { "title": "User Marketplace Purchase", "description": "User Marketplace Purchase", "type": "object", "properties": { "billing_cycle": { "type": "string", "examples": [ "monthly" ] }, "next_billing_date": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2017-11-11T00:00:00Z" ] }, "unit_count": { "type": [ "integer", "null" ] }, "on_free_trial": { "type": "boolean", "examples": [ true ] }, "free_trial_ends_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2017-11-11T00:00:00Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2017-11-02T01:12:12Z" ] }, "account": { "title": "Marketplace Account", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "type": { "type": "string" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "email": { "type": [ "string", "null" ], "format": "email" }, "organization_billing_email": { "type": [ "string", "null" ], "format": "email" } }, "required": [ "url", "id", "type", "login" ] }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313" ] }, "accounts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/marketplace_listing/plans/1313/accounts" ] }, "id": { "type": "integer", "examples": [ 1313 ] }, "number": { "type": "integer", "examples": [ 3 ] }, "name": { "type": "string", "examples": [ "Pro" ] }, "description": { "type": "string", "examples": [ "A professional-grade CI solution" ] }, "monthly_price_in_cents": { "type": "integer", "examples": [ 1099 ] }, "yearly_price_in_cents": { "type": "integer", "examples": [ 11870 ] }, "price_model": { "type": "string", "examples": [ "flat-rate" ] }, "has_free_trial": { "type": "boolean", "examples": [ true ] }, "unit_name": { "type": [ "string", "null" ] }, "state": { "type": "string", "examples": [ "published" ] }, "bullets": { "type": "array", "items": { "type": "string" }, "examples": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } }, "required": [ "billing_cycle", "next_billing_date", "unit_count", "updated_at", "on_free_trial", "free_trial_ends_on", "account", "plan" ] } } } } ], "previews": [], "descriptionHTML": "Lists the active subscriptions for the authenticated user. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" } ] } ], "oauth-applications": [ { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/applications/{client_id}/grant", "title": "Delete an app authorization", "category": "apps", "subcategory": "oauth-applications", "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.
", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "bodyParameters": [ { "type": "string", "name": "access_token", "in": "body", "description": "The OAuth access token used to authenticate to the GitHub API.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" }, "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. You must also provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted.\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.
No Content
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/applications/{client_id}/token", "title": "Check a token", "category": "apps", "subcategory": "oauth-applications", "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.
", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "bodyParameters": [ { "type": "string", "name": "access_token", "in": "body", "description": "The access_token of the OAuth application.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" }, "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo", "user" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "Iv1.8a61f9b3a7aba766" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "fingerprint": "jklmnop12345678", "expires_at": "2011-09-08T17:26:27Z", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, "schema": { "title": "Authorization", "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "scopes": { "description": "A list of scopes that this authorization is in.", "type": [ "array", "null" ], "items": { "type": "string" } }, "token": { "type": "string" }, "token_last_eight": { "type": [ "string", "null" ] }, "hashed_token": { "type": [ "string", "null" ] }, "app": { "type": "object", "properties": { "client_id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "client_id", "name", "url" ] }, "note": { "type": [ "string", "null" ] }, "note_url": { "type": [ "string", "null" ], "format": "uri" }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "fingerprint": { "type": [ "string", "null" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "installation": { "anyOf": [ { "type": "null" }, { "title": "Scoped Installation", "type": "object", "properties": { "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user-to-server access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", "enum": [ "read", "write" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "single_file_name": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "has_multiple_single_files": { "type": "boolean", "examples": [ true ] }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "examples": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "account": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "permissions", "repository_selection", "single_file_name", "repositories_url", "account" ] } ] }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "app", "id", "note", "note_url", "scopes", "token", "hashed_token", "token_last_eight", "fingerprint", "url", "created_at", "updated_at", "expires_at" ] } } } ], "previews": [], "descriptionHTML": "OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use Basic Authentication to use this endpoint, where the username is the OAuth application client_id and the password is its client_secret. Invalid tokens will return 404 NOT FOUND.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/applications/{client_id}/token", "title": "Reset a token", "category": "apps", "subcategory": "oauth-applications", "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.
", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "bodyParameters": [ { "type": "string", "name": "access_token", "in": "body", "description": "The access_token of the OAuth application.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" }, "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo", "user" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "Iv1.8a61f9b3a7aba766" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "fingerprint": "jklmnop12345678", "expires_at": "2011-09-08T17:26:27Z", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, "schema": { "title": "Authorization", "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "scopes": { "description": "A list of scopes that this authorization is in.", "type": [ "array", "null" ], "items": { "type": "string" } }, "token": { "type": "string" }, "token_last_eight": { "type": [ "string", "null" ] }, "hashed_token": { "type": [ "string", "null" ] }, "app": { "type": "object", "properties": { "client_id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "client_id", "name", "url" ] }, "note": { "type": [ "string", "null" ] }, "note_url": { "type": [ "string", "null" ], "format": "uri" }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "fingerprint": { "type": [ "string", "null" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "installation": { "anyOf": [ { "type": "null" }, { "title": "Scoped Installation", "type": "object", "properties": { "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user-to-server access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", "enum": [ "read", "write" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "single_file_name": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "has_multiple_single_files": { "type": "boolean", "examples": [ true ] }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "examples": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "account": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "permissions", "repository_selection", "single_file_name", "repositories_url", "account" ] } ] }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "app", "id", "note", "note_url", "scopes", "token", "hashed_token", "token_last_eight", "fingerprint", "url", "created_at", "updated_at", "expires_at" ] } } } ], "previews": [], "descriptionHTML": "OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/applications/{client_id}/token", "title": "Delete an app token", "category": "apps", "subcategory": "oauth-applications", "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.
", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "bodyParameters": [ { "type": "string", "name": "access_token", "in": "body", "description": "The OAuth access token used to authenticate to the GitHub API.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" }, "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "OAuth application owners can revoke a single token for an OAuth application. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password.
No Content
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/applications/{client_id}/token/scoped", "title": "Create a scoped access token", "category": "apps", "subcategory": "oauth-applications", "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.
", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "bodyParameters": [ { "type": "string", "name": "access_token", "in": "body", "description": "The OAuth access token used to authenticate to the GitHub API.
", "isRequired": true }, { "type": "string", "name": "target", "in": "body", "description": "The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.
The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.
The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.
The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.
The permissions granted to the user-to-server access token.
", "childParamsGroups": [ { "type": "string", "name": "actions", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "administration", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "checks", "description": "The level of permission to grant the access token for checks on code.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "contents", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "deployments", "description": "The level of permission to grant the access token for deployments and deployment statuses.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "environments", "description": "The level of permission to grant the access token for managing repository environments.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "issues", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "metadata", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "packages", "description": "The level of permission to grant the access token for packages published to GitHub Packages.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "pages", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "pull_requests", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_hooks", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "repository_projects", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.
", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "secret_scanning_alerts", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "secrets", "description": "The level of permission to grant the access token to manage repository secrets.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "security_events", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "single_file", "description": "The level of permission to grant the access token to manage just a single file.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "statuses", "description": "The level of permission to grant the access token for commit statuses.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "vulnerability_alerts", "description": "The level of permission to grant the access token to manage Dependabot alerts.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "workflows", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.
", "enum": [ "write" ] }, { "type": "string", "name": "members", "description": "The level of permission to grant the access token for organization teams and members.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_administration", "description": "The level of permission to grant the access token to manage access to an organization.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_custom_roles", "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_hooks", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_plan", "description": "The level of permission to grant the access token for viewing an organization's plan.
", "enum": [ "read" ] }, { "type": "string", "name": "organization_projects", "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).
", "enum": [ "read", "write", "admin" ] }, { "type": "string", "name": "organization_packages", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_secrets", "description": "The level of permission to grant the access token to manage organization secrets.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_self_hosted_runners", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "organization_user_blocking", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.
", "enum": [ "read", "write" ] }, { "type": "string", "name": "team_discussions", "description": "The level of permission to grant the access token to manage team discussions and related comments.
", "enum": [ "read", "write" ] } ] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a", "target": "octocat", "permissions": { "metadata": "read", "issues": "write", "contents": "read" } }, "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "Iv1.8a61f9b3a7aba766" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "fingerprint": "jklmnop12345678", "expires_at": "2011-09-08T17:26:27Z", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "installation": { "permissions": { "metadata": "read", "issues": "write", "contents": "read" }, "repository_selection": "selected", "single_file_name": ".github/workflow.yml", "repositories_url": "https://api.github.com/user/repos", "account": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "has_multiple_single_files": false, "single_file_paths": [] } }, "schema": { "title": "Authorization", "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "scopes": { "description": "A list of scopes that this authorization is in.", "type": [ "array", "null" ], "items": { "type": "string" } }, "token": { "type": "string" }, "token_last_eight": { "type": [ "string", "null" ] }, "hashed_token": { "type": [ "string", "null" ] }, "app": { "type": "object", "properties": { "client_id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "client_id", "name", "url" ] }, "note": { "type": [ "string", "null" ] }, "note_url": { "type": [ "string", "null" ], "format": "uri" }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "fingerprint": { "type": [ "string", "null" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "installation": { "anyOf": [ { "type": "null" }, { "title": "Scoped Installation", "type": "object", "properties": { "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user-to-server access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", "enum": [ "read", "write" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "single_file_name": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "has_multiple_single_files": { "type": "boolean", "examples": [ true ] }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "examples": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "account": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "permissions", "repository_selection", "single_file_name", "repositories_url", "account" ] } ] }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "app", "id", "note", "note_url", "scopes", "token", "hashed_token", "token_last_eight", "fingerprint", "url", "created_at", "updated_at", "expires_at" ] } } } ], "previews": [], "descriptionHTML": "Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "webhooks": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/app/hook/config", "title": "Get a webhook configuration for an app", "category": "apps", "subcategory": "webhooks", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" }, "schema": { "title": "Webhook Configuration", "description": "Configuration object of the webhook", "type": "object", "properties": { "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "format": "uri", "examples": [ "https://example.com/webhook" ] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ "\"json\"" ] }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "examples": [ "\"0\"" ] }, { "type": "number" } ] } } } } } ], "previews": [], "descriptionHTML": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/app/hook/config", "title": "Update a webhook configuration for an app", "category": "apps", "subcategory": "webhooks", "parameters": [], "bodyParameters": [ { "type": "string", "name": "url", "in": "body", "description": "The URL to which the payloads will be delivered.
" }, { "type": "string", "name": "content_type", "in": "body", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
Response
", "example": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" }, "schema": { "title": "Webhook Configuration", "description": "Configuration object of the webhook", "type": "object", "properties": { "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "format": "uri", "examples": [ "https://example.com/webhook" ] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ "\"json\"" ] }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "examples": [ "\"0\"" ] }, { "type": "number" } ] } } } } } ], "previews": [], "descriptionHTML": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/app/hook/deliveries", "title": "List deliveries for an app webhook", "category": "apps", "subcategory": "webhooks", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "cursor", "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link header for the next and previous page cursors.
Response
", "example": [ { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-03T00:57:16Z", "redelivery": false, "duration": 0.27, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456 }, { "id": 123456789, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-04T00:57:16Z", "redelivery": true, "duration": 0.28, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456 } ], "schema": { "type": "array", "items": { "title": "Simple webhook delivery", "description": "Delivery made by a webhook, without request and response information.", "type": "object", "properties": { "id": { "description": "Unique identifier of the webhook delivery.", "type": "integer", "examples": [ 42 ] }, "guid": { "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", "type": "string", "examples": [ "58474f00-b361-11eb-836d-0e4f3503ccbe" ] }, "delivered_at": { "description": "Time when the webhook delivery occurred.", "type": "string", "format": "date-time", "examples": [ "2021-05-12T20:33:44Z" ] }, "redelivery": { "description": "Whether the webhook delivery is a redelivery.", "type": "boolean", "examples": [ false ] }, "duration": { "description": "Time spent delivering.", "type": "number", "examples": [ 0.03 ] }, "status": { "description": "Describes the response returned after attempting the delivery.", "type": "string", "examples": [ "failed to connect" ] }, "status_code": { "description": "Status code received when delivery was made.", "type": "integer", "examples": [ 502 ] }, "event": { "description": "The event that triggered the delivery.", "type": "string", "examples": [ "issues" ] }, "action": { "description": "The type of activity for the event that triggered the delivery.", "type": [ "string", "null" ], "examples": [ "opened" ] }, "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": [ "integer", "null" ], "examples": [ 123 ] }, "repository_id": { "description": "The id of the repository associated with this event.", "type": [ "integer", "null" ], "examples": [ 123 ] } }, "required": [ "id", "guid", "delivered_at", "redelivery", "duration", "status", "status_code", "event", "action", "installation_id", "repository_id" ] } } } } ], "previews": [], "descriptionHTML": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/app/hook/deliveries/{delivery_id}", "title": "Get a delivery for an app webhook", "category": "apps", "subcategory": "webhooks", "parameters": [ { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "delivery_id": "DELIVERY_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-03T00:57:16Z", "redelivery": false, "duration": 0.27, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456, "url": "https://www.example.com", "request": { "headers": { "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "Accept": "*/*", "X-GitHub-Hook-ID": "42", "User-Agent": "GitHub-Hookshot/b8c71d8", "X-GitHub-Event": "issues", "X-GitHub-Hook-Installation-Target-ID": "123", "X-GitHub-Hook-Installation-Target-Type": "repository", "content-type": "application/json", "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" }, "payload": { "action": "opened", "issue": { "body": "foo" }, "repository": { "id": 123 } } }, "response": { "headers": { "Content-Type": "text/html;charset=utf-8" }, "payload": "ok" } }, "schema": { "title": "Webhook delivery", "description": "Delivery made by a webhook.", "type": "object", "properties": { "id": { "description": "Unique identifier of the delivery.", "type": "integer", "examples": [ 42 ] }, "guid": { "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", "type": "string", "examples": [ "58474f00-b361-11eb-836d-0e4f3503ccbe" ] }, "delivered_at": { "description": "Time when the delivery was delivered.", "type": "string", "format": "date-time", "examples": [ "2021-05-12T20:33:44Z" ] }, "redelivery": { "description": "Whether the delivery is a redelivery.", "type": "boolean", "examples": [ false ] }, "duration": { "description": "Time spent delivering.", "type": "number", "examples": [ 0.03 ] }, "status": { "description": "Description of the status of the attempted delivery", "type": "string", "examples": [ "failed to connect" ] }, "status_code": { "description": "Status code received when delivery was made.", "type": "integer", "examples": [ 502 ] }, "event": { "description": "The event that triggered the delivery.", "type": "string", "examples": [ "issues" ] }, "action": { "description": "The type of activity for the event that triggered the delivery.", "type": [ "string", "null" ], "examples": [ "opened" ] }, "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": [ "integer", "null" ], "examples": [ 123 ] }, "repository_id": { "description": "The id of the repository associated with this event.", "type": [ "integer", "null" ], "examples": [ 123 ] }, "url": { "description": "The URL target of the delivery.", "type": "string", "examples": [ "https://www.example.com" ] }, "request": { "type": "object", "properties": { "headers": { "description": "The request headers sent with the webhook delivery.", "type": [ "object", "null" ], "additionalProperties": true }, "payload": { "description": "The webhook payload.", "type": [ "object", "null" ], "additionalProperties": true } }, "required": [ "headers", "payload" ] }, "response": { "type": "object", "properties": { "headers": { "description": "The response headers received when the delivery was made.", "type": [ "object", "null" ], "additionalProperties": true }, "payload": { "description": "The response payload received.", "type": [ "string", "null" ], "additionalProperties": true } }, "required": [ "headers", "payload" ] } }, "required": [ "id", "guid", "delivered_at", "redelivery", "duration", "status", "status_code", "event", "action", "installation_id", "repository_id", "request", "response" ] } } } ], "previews": [], "descriptionHTML": "Returns a delivery for the webhook configured for a GitHub App.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/app/hook/deliveries/{delivery_id}/attempts", "title": "Redeliver a delivery for an app webhook", "category": "apps", "subcategory": "webhooks", "parameters": [ { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "delivery_id": "DELIVERY_ID" } }, "response": { "statusCode": "202", "description": "Accepted
" } } ], "previews": [], "descriptionHTML": "Redeliver a delivery for the webhook configured for a GitHub App.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ] }, "billing": { "billing": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/settings/billing/actions", "title": "Get GitHub Actions billing for an organization", "category": "billing", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_minutes_used": 305, "total_paid_minutes_used": 0, "included_minutes": 3000, "minutes_used_breakdown": { "UBUNTU": 205, "MACOS": 10, "WINDOWS": 90 } }, "schema": { "type": "object", "properties": { "total_minutes_used": { "type": "integer", "description": "The sum of the free and paid GitHub Actions minutes used." }, "total_paid_minutes_used": { "type": "integer", "description": "The total paid GitHub Actions minutes used." }, "included_minutes": { "type": "integer", "description": "The amount of free GitHub Actions minutes available." }, "minutes_used_breakdown": { "type": "object", "properties": { "UBUNTU": { "type": "integer", "description": "Total minutes used on Ubuntu runner machines." }, "MACOS": { "type": "integer", "description": "Total minutes used on macOS runner machines." }, "WINDOWS": { "type": "integer", "description": "Total minutes used on Windows runner machines." }, "ubuntu_4_core": { "type": "integer", "description": "Total minutes used on Ubuntu 4 core runner machines." }, "ubuntu_8_core": { "type": "integer", "description": "Total minutes used on Ubuntu 8 core runner machines." }, "ubuntu_16_core": { "type": "integer", "description": "Total minutes used on Ubuntu 16 core runner machines." }, "ubuntu_32_core": { "type": "integer", "description": "Total minutes used on Ubuntu 32 core runner machines." }, "ubuntu_64_core": { "type": "integer", "description": "Total minutes used on Ubuntu 64 core runner machines." }, "windows_4_core": { "type": "integer", "description": "Total minutes used on Windows 4 core runner machines." }, "windows_8_core": { "type": "integer", "description": "Total minutes used on Windows 8 core runner machines." }, "windows_16_core": { "type": "integer", "description": "Total minutes used on Windows 16 core runner machines." }, "windows_32_core": { "type": "integer", "description": "Total minutes used on Windows 32 core runner machines." }, "windows_64_core": { "type": "integer", "description": "Total minutes used on Windows 64 core runner machines." }, "total": { "type": "integer", "description": "Total minutes used on all runner machines." } } } }, "required": [ "total_minutes_used", "total_paid_minutes_used", "included_minutes", "minutes_used_breakdown" ] } } } ], "previews": [], "descriptionHTML": "Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nAccess tokens must have the repo or admin:org scope.
OK
" } ], "subcategory": "billing" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/settings/billing/advanced-security", "title": "Get GitHub Advanced Security active committers for an organization", "category": "billing", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Success
", "example": { "total_advanced_security_committers": 2, "total_count": 2, "repositories": [ { "name": "octocat-org/Hello-World", "advanced_security_committers": 2, "advanced_security_committers_breakdown": [ { "user_login": "octocat", "last_pushed_date": "2021-11-03" }, { "user_login": "octokitten", "last_pushed_date": "2021-10-25" } ] }, { "name": "octocat-org/server", "advanced_security_committers": 1, "advanced_security_committers_breakdown": [ { "user_login": "octokitten", "last_pushed_date": "2021-10-26" } ] } ] }, "schema": { "type": "object", "properties": { "total_advanced_security_committers": { "type": "integer", "examples": [ 25 ] }, "total_count": { "type": "integer", "examples": [ 2 ] }, "repositories": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "advanced_security_committers": { "type": "integer", "examples": [ 25 ] }, "advanced_security_committers_breakdown": { "type": "array", "items": { "type": "object", "properties": { "user_login": { "type": "string" }, "last_pushed_date": { "type": "string", "examples": [ "2021-11-03" ] } }, "required": [ "user_login", "last_pushed_date" ] } } }, "required": [ "name", "advanced_security_committers", "advanced_security_committers_breakdown" ] } } }, "required": [ "repositories" ] } } } ], "previews": [], "descriptionHTML": "Gets the GitHub Advanced Security active committers for an organization per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.
If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.
The total number of repositories with committer information is tracked by the total_count field.
Success
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" } ], "subcategory": "billing" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/settings/billing/packages", "title": "Get GitHub Packages billing for an organization", "category": "billing", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, "included_gigabytes_bandwidth": 10 }, "schema": { "type": "object", "properties": { "total_gigabytes_bandwidth_used": { "type": "integer", "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." }, "total_paid_gigabytes_bandwidth_used": { "type": "integer", "description": "Total paid storage space (GB) for GitHuub Packages." }, "included_gigabytes_bandwidth": { "type": "integer", "description": "Free storage space (GB) for GitHub Packages." } }, "required": [ "total_gigabytes_bandwidth_used", "total_paid_gigabytes_bandwidth_used", "included_gigabytes_bandwidth" ] } } } ], "previews": [], "descriptionHTML": "Gets the free and paid storage used for GitHub Packages in gigabytes.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nAccess tokens must have the repo or admin:org scope.
OK
" } ], "subcategory": "billing" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/settings/billing/shared-storage", "title": "Get shared storage billing for an organization", "category": "billing", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, "estimated_storage_for_month": 40 }, "schema": { "type": "object", "properties": { "days_left_in_billing_cycle": { "type": "integer", "description": "Numbers of days left in billing cycle." }, "estimated_paid_storage_for_month": { "type": "integer", "description": "Estimated storage space (GB) used in billing cycle." }, "estimated_storage_for_month": { "type": "integer", "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." } }, "required": [ "days_left_in_billing_cycle", "estimated_paid_storage_for_month", "estimated_storage_for_month" ] } } } ], "previews": [], "descriptionHTML": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nAccess tokens must have the repo or admin:org scope.
OK
" } ], "subcategory": "billing" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/settings/billing/actions", "title": "Get GitHub Actions billing for a user", "category": "billing", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_minutes_used": 305, "total_paid_minutes_used": 0, "included_minutes": 3000, "minutes_used_breakdown": { "UBUNTU": 205, "MACOS": 10, "WINDOWS": 90 } }, "schema": { "type": "object", "properties": { "total_minutes_used": { "type": "integer", "description": "The sum of the free and paid GitHub Actions minutes used." }, "total_paid_minutes_used": { "type": "integer", "description": "The total paid GitHub Actions minutes used." }, "included_minutes": { "type": "integer", "description": "The amount of free GitHub Actions minutes available." }, "minutes_used_breakdown": { "type": "object", "properties": { "UBUNTU": { "type": "integer", "description": "Total minutes used on Ubuntu runner machines." }, "MACOS": { "type": "integer", "description": "Total minutes used on macOS runner machines." }, "WINDOWS": { "type": "integer", "description": "Total minutes used on Windows runner machines." }, "ubuntu_4_core": { "type": "integer", "description": "Total minutes used on Ubuntu 4 core runner machines." }, "ubuntu_8_core": { "type": "integer", "description": "Total minutes used on Ubuntu 8 core runner machines." }, "ubuntu_16_core": { "type": "integer", "description": "Total minutes used on Ubuntu 16 core runner machines." }, "ubuntu_32_core": { "type": "integer", "description": "Total minutes used on Ubuntu 32 core runner machines." }, "ubuntu_64_core": { "type": "integer", "description": "Total minutes used on Ubuntu 64 core runner machines." }, "windows_4_core": { "type": "integer", "description": "Total minutes used on Windows 4 core runner machines." }, "windows_8_core": { "type": "integer", "description": "Total minutes used on Windows 8 core runner machines." }, "windows_16_core": { "type": "integer", "description": "Total minutes used on Windows 16 core runner machines." }, "windows_32_core": { "type": "integer", "description": "Total minutes used on Windows 32 core runner machines." }, "windows_64_core": { "type": "integer", "description": "Total minutes used on Windows 64 core runner machines." }, "total": { "type": "integer", "description": "Total minutes used on all runner machines." } } } }, "required": [ "total_minutes_used", "total_paid_minutes_used", "included_minutes", "minutes_used_breakdown" ] } } } ], "previews": [], "descriptionHTML": "Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nAccess tokens must have the user scope.
OK
" } ], "subcategory": "billing" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/settings/billing/packages", "title": "Get GitHub Packages billing for a user", "category": "billing", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, "included_gigabytes_bandwidth": 10 }, "schema": { "type": "object", "properties": { "total_gigabytes_bandwidth_used": { "type": "integer", "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." }, "total_paid_gigabytes_bandwidth_used": { "type": "integer", "description": "Total paid storage space (GB) for GitHuub Packages." }, "included_gigabytes_bandwidth": { "type": "integer", "description": "Free storage space (GB) for GitHub Packages." } }, "required": [ "total_gigabytes_bandwidth_used", "total_paid_gigabytes_bandwidth_used", "included_gigabytes_bandwidth" ] } } } ], "previews": [], "descriptionHTML": "Gets the free and paid storage used for GitHub Packages in gigabytes.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nAccess tokens must have the user scope.
OK
" } ], "subcategory": "billing" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/settings/billing/shared-storage", "title": "Get shared storage billing for a user", "category": "billing", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, "estimated_storage_for_month": 40 }, "schema": { "type": "object", "properties": { "days_left_in_billing_cycle": { "type": "integer", "description": "Numbers of days left in billing cycle." }, "estimated_paid_storage_for_month": { "type": "integer", "description": "Estimated storage space (GB) used in billing cycle." }, "estimated_storage_for_month": { "type": "integer", "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." } }, "required": [ "days_left_in_billing_cycle", "estimated_paid_storage_for_month", "estimated_storage_for_month" ] } } } ], "previews": [], "descriptionHTML": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nAccess tokens must have the user scope.
OK
" } ], "subcategory": "billing" } ] }, "branches": { "branches": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches", "title": "List branches", "category": "branches", "subcategory": "branches", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "protected", "description": "Setting to true returns only protected branches. When set to false, only unprotected branches are returned. Omitting this parameter returns all branches.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "name": "master", "commit": { "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" }, "protected": true, "protection": { "required_status_checks": { "enforcement_level": "non_admins", "contexts": [ "ci-test", "linter" ] } }, "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" } ], "schema": { "type": "array", "items": { "title": "Short Branch", "description": "Short Branch", "type": "object", "properties": { "name": { "type": "string" }, "commit": { "type": "object", "properties": { "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "sha", "url" ] }, "protected": { "type": "boolean" }, "protection": { "title": "Branch Protection", "description": "Branch Protection", "type": "object", "properties": { "url": { "type": "string" }, "enabled": { "type": "boolean" }, "required_status_checks": { "title": "Protected Branch Required Status Check", "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { "type": "string" }, "enforcement_level": { "type": "string" }, "contexts": { "type": "array", "items": { "type": "string" } }, "checks": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string" }, "app_id": { "type": [ "integer", "null" ] } }, "required": [ "context", "app_id" ] } }, "contexts_url": { "type": "string" }, "strict": { "type": "boolean" } }, "required": [ "contexts", "checks" ] }, "enforce_admins": { "title": "Protected Branch Admin Enforced", "description": "Protected Branch Admin Enforced", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, "enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "url", "enabled" ] }, "required_pull_request_reviews": { "title": "Protected Branch Pull Request Review", "description": "Protected Branch Pull Request Review", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" ] }, "dismissal_restrictions": { "type": "object", "properties": { "users": { "description": "The list of users with review dismissal access.", "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "description": "The list of teams with review dismissal access.", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "description": "The list of apps with review dismissal access.", "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } }, "url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" ] }, "users_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" ] }, "teams_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" ] } } }, "bypass_pull_request_allowances": { "type": "object", "description": "Allow specific users, teams, or apps to bypass pull request requirements.", "properties": { "users": { "description": "The list of users allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "description": "The list of teams allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "description": "The list of apps allowed to bypass pull request requirements.", "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } } }, "dismiss_stale_reviews": { "type": "boolean", "examples": [ true ] }, "require_code_owner_reviews": { "type": "boolean", "examples": [ true ] }, "required_approving_review_count": { "type": "integer", "minimum": 0, "maximum": 6, "examples": [ 2 ] } }, "required": [ "dismiss_stale_reviews", "require_code_owner_reviews" ] }, "restrictions": { "title": "Branch Restriction Policy", "description": "Branch Restriction Policy", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "users_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "apps_url": { "type": "string", "format": "uri" }, "users": { "type": "array", "items": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } } }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "members_url": { "type": "string" }, "repositories_url": { "type": "string" }, "parent": { "type": [ "string", "null" ] } } } }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "node_id": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "hooks_url": { "type": "string" }, "issues_url": { "type": "string" }, "members_url": { "type": "string" }, "public_members_url": { "type": "string" }, "avatar_url": { "type": "string" }, "description": { "type": "string" }, "gravatar_id": { "type": "string", "examples": [ "\"\"" ] }, "html_url": { "type": "string", "examples": [ "\"https://github.com/testorg-ea8ec76d71c3af4b\"" ] }, "followers_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" ] }, "following_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" ] }, "gists_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" ] }, "starred_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" ] }, "subscriptions_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" ] }, "organizations_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" ] }, "received_events_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" ] }, "type": { "type": "string", "examples": [ "\"Organization\"" ] }, "site_admin": { "type": "boolean", "examples": [ false ] } } }, "name": { "type": "string" }, "description": { "type": "string" }, "external_url": { "type": "string" }, "html_url": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "metadata": { "type": "string" }, "contents": { "type": "string" }, "issues": { "type": "string" }, "single_file": { "type": "string" } } }, "events": { "type": "array", "items": { "type": "string" } } } } } }, "required": [ "url", "users_url", "teams_url", "apps_url", "users", "teams", "apps" ] }, "required_linear_history": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "allow_force_pushes": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "allow_deletions": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "block_creations": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "required_conversation_resolution": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "name": { "type": "string", "examples": [ "\"branch/with/protection\"" ] }, "protection_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" ] }, "required_signatures": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" ] }, "enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "url", "enabled" ] } } }, "protection_url": { "type": "string", "format": "uri" } }, "required": [ "name", "commit", "protected" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}", "title": "Get a branch", "category": "branches", "subcategory": "branches", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "main", "commit": { "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", "commit": { "author": { "name": "The Octocat", "email": "octocat@nowhere.com", "date": "2012-03-06T23:06:50Z" }, "committer": { "name": "The Octocat", "email": "octocat@nowhere.com", "date": "2012-03-06T23:06:50Z" }, "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", "tree": { "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" }, "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "comment_count": 77, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", "author": { "login": "octocat", "id": 583231, "node_id": "MDQ6VXNlcjU4MzIzMQ==", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "committer": { "login": "octocat", "id": 583231, "node_id": "MDQ6VXNlcjU4MzIzMQ==", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "parents": [ { "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" }, { "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" } ] }, "_links": { "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", "html": "https://github.com/octocat/Hello-World/tree/main" }, "protected": false, "protection": { "enabled": false, "required_status_checks": { "enforcement_level": "off", "contexts": [], "checks": [] } }, "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" }, "schema": { "title": "Branch With Protection", "description": "Branch With Protection", "type": "object", "properties": { "name": { "type": "string" }, "commit": { "title": "Commit", "description": "Commit", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "sha": { "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "node_id": { "type": "string", "examples": [ "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" ] }, "commit": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "message": { "type": "string", "examples": [ "Fix all the bugs" ] }, "comment_count": { "type": "integer", "examples": [ 0 ] }, "tree": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "827efc6d56897b048c772eb4087f854f46256132" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" ] } }, "required": [ "sha", "url" ] }, "verification": { "title": "Verification", "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "payload": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "payload", "signature" ] } }, "required": [ "author", "committer", "comment_count", "message", "tree", "url" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" ] } }, "required": [ "sha", "url" ] } }, "stats": { "type": "object", "properties": { "additions": { "type": "integer" }, "deletions": { "type": "integer" }, "total": { "type": "integer" } } }, "files": { "type": "array", "items": { "title": "Diff Entry", "description": "Diff Entry", "type": "object", "properties": { "sha": { "type": "string", "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] }, "filename": { "type": "string", "examples": [ "file1.txt" ] }, "status": { "type": "string", "enum": [ "added", "removed", "modified", "renamed", "copied", "changed", "unchanged" ], "examples": [ "added" ] }, "additions": { "type": "integer", "examples": [ 103 ] }, "deletions": { "type": "integer", "examples": [ 21 ] }, "changes": { "type": "integer", "examples": [ 124 ] }, "blob_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "raw_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "contents_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "patch": { "type": "string", "examples": [ "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" ] }, "previous_filename": { "type": "string", "examples": [ "file.txt" ] } }, "required": [ "additions", "blob_url", "changes", "contents_url", "deletions", "filename", "raw_url", "sha", "status" ] } } }, "required": [ "url", "sha", "node_id", "html_url", "comments_url", "commit", "author", "committer", "parents" ] }, "_links": { "type": "object", "properties": { "html": { "type": "string" }, "self": { "type": "string", "format": "uri" } }, "required": [ "html", "self" ] }, "protected": { "type": "boolean" }, "protection": { "title": "Branch Protection", "description": "Branch Protection", "type": "object", "properties": { "url": { "type": "string" }, "enabled": { "type": "boolean" }, "required_status_checks": { "title": "Protected Branch Required Status Check", "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { "type": "string" }, "enforcement_level": { "type": "string" }, "contexts": { "type": "array", "items": { "type": "string" } }, "checks": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string" }, "app_id": { "type": [ "integer", "null" ] } }, "required": [ "context", "app_id" ] } }, "contexts_url": { "type": "string" }, "strict": { "type": "boolean" } }, "required": [ "contexts", "checks" ] }, "enforce_admins": { "title": "Protected Branch Admin Enforced", "description": "Protected Branch Admin Enforced", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, "enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "url", "enabled" ] }, "required_pull_request_reviews": { "title": "Protected Branch Pull Request Review", "description": "Protected Branch Pull Request Review", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" ] }, "dismissal_restrictions": { "type": "object", "properties": { "users": { "description": "The list of users with review dismissal access.", "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "description": "The list of teams with review dismissal access.", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "description": "The list of apps with review dismissal access.", "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } }, "url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" ] }, "users_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" ] }, "teams_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" ] } } }, "bypass_pull_request_allowances": { "type": "object", "description": "Allow specific users, teams, or apps to bypass pull request requirements.", "properties": { "users": { "description": "The list of users allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "description": "The list of teams allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "description": "The list of apps allowed to bypass pull request requirements.", "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } } }, "dismiss_stale_reviews": { "type": "boolean", "examples": [ true ] }, "require_code_owner_reviews": { "type": "boolean", "examples": [ true ] }, "required_approving_review_count": { "type": "integer", "minimum": 0, "maximum": 6, "examples": [ 2 ] } }, "required": [ "dismiss_stale_reviews", "require_code_owner_reviews" ] }, "restrictions": { "title": "Branch Restriction Policy", "description": "Branch Restriction Policy", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "users_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "apps_url": { "type": "string", "format": "uri" }, "users": { "type": "array", "items": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } } }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "members_url": { "type": "string" }, "repositories_url": { "type": "string" }, "parent": { "type": [ "string", "null" ] } } } }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "node_id": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "hooks_url": { "type": "string" }, "issues_url": { "type": "string" }, "members_url": { "type": "string" }, "public_members_url": { "type": "string" }, "avatar_url": { "type": "string" }, "description": { "type": "string" }, "gravatar_id": { "type": "string", "examples": [ "\"\"" ] }, "html_url": { "type": "string", "examples": [ "\"https://github.com/testorg-ea8ec76d71c3af4b\"" ] }, "followers_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" ] }, "following_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" ] }, "gists_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" ] }, "starred_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" ] }, "subscriptions_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" ] }, "organizations_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" ] }, "received_events_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" ] }, "type": { "type": "string", "examples": [ "\"Organization\"" ] }, "site_admin": { "type": "boolean", "examples": [ false ] } } }, "name": { "type": "string" }, "description": { "type": "string" }, "external_url": { "type": "string" }, "html_url": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "metadata": { "type": "string" }, "contents": { "type": "string" }, "issues": { "type": "string" }, "single_file": { "type": "string" } } }, "events": { "type": "array", "items": { "type": "string" } } } } } }, "required": [ "url", "users_url", "teams_url", "apps_url", "users", "teams", "apps" ] }, "required_linear_history": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "allow_force_pushes": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "allow_deletions": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "block_creations": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "required_conversation_resolution": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "name": { "type": "string", "examples": [ "\"branch/with/protection\"" ] }, "protection_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" ] }, "required_signatures": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" ] }, "enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "url", "enabled" ] } } }, "protection_url": { "type": "string", "format": "uri" }, "pattern": { "type": "string", "examples": [ "\"mas*\"" ] }, "required_approving_review_count": { "type": "integer", "examples": [ 1 ] } }, "required": [ "name", "commit", "_links", "protection", "protected", "protection_url" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "301", "description": "Moved permanently
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", "title": "Rename a branch", "category": "branches", "subcategory": "branches", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "string", "name": "new_name", "in": "body", "description": "The new name of the branch.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "my_renamed_branch" }, "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "name": "master", "commit": { "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", "commit": { "author": { "name": "The Octocat", "date": "2012-03-06T15:06:50-08:00", "email": "octocat@nowhere.com" }, "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", "tree": { "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" }, "committer": { "name": "The Octocat", "date": "2012-03-06T15:06:50-08:00", "email": "octocat@nowhere.com" }, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null }, "comment_count": 0 }, "author": { "gravatar_id": "", "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", "id": 583231, "login": "octocat", "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "parents": [ { "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" }, { "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" } ], "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "committer": { "gravatar_id": "", "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", "id": 583231, "login": "octocat", "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" }, "_links": { "html": "https://github.com/octocat/Hello-World/tree/master", "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" }, "protected": true, "protection": { "required_status_checks": { "enforcement_level": "non_admins", "contexts": [ "ci-test", "linter" ] } }, "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" }, "schema": { "title": "Branch With Protection", "description": "Branch With Protection", "type": "object", "properties": { "name": { "type": "string" }, "commit": { "title": "Commit", "description": "Commit", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "sha": { "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "node_id": { "type": "string", "examples": [ "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" ] }, "commit": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "message": { "type": "string", "examples": [ "Fix all the bugs" ] }, "comment_count": { "type": "integer", "examples": [ 0 ] }, "tree": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "827efc6d56897b048c772eb4087f854f46256132" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" ] } }, "required": [ "sha", "url" ] }, "verification": { "title": "Verification", "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "payload": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "payload", "signature" ] } }, "required": [ "author", "committer", "comment_count", "message", "tree", "url" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" ] } }, "required": [ "sha", "url" ] } }, "stats": { "type": "object", "properties": { "additions": { "type": "integer" }, "deletions": { "type": "integer" }, "total": { "type": "integer" } } }, "files": { "type": "array", "items": { "title": "Diff Entry", "description": "Diff Entry", "type": "object", "properties": { "sha": { "type": "string", "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] }, "filename": { "type": "string", "examples": [ "file1.txt" ] }, "status": { "type": "string", "enum": [ "added", "removed", "modified", "renamed", "copied", "changed", "unchanged" ], "examples": [ "added" ] }, "additions": { "type": "integer", "examples": [ 103 ] }, "deletions": { "type": "integer", "examples": [ 21 ] }, "changes": { "type": "integer", "examples": [ 124 ] }, "blob_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "raw_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "contents_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "patch": { "type": "string", "examples": [ "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" ] }, "previous_filename": { "type": "string", "examples": [ "file.txt" ] } }, "required": [ "additions", "blob_url", "changes", "contents_url", "deletions", "filename", "raw_url", "sha", "status" ] } } }, "required": [ "url", "sha", "node_id", "html_url", "comments_url", "commit", "author", "committer", "parents" ] }, "_links": { "type": "object", "properties": { "html": { "type": "string" }, "self": { "type": "string", "format": "uri" } }, "required": [ "html", "self" ] }, "protected": { "type": "boolean" }, "protection": { "title": "Branch Protection", "description": "Branch Protection", "type": "object", "properties": { "url": { "type": "string" }, "enabled": { "type": "boolean" }, "required_status_checks": { "title": "Protected Branch Required Status Check", "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { "type": "string" }, "enforcement_level": { "type": "string" }, "contexts": { "type": "array", "items": { "type": "string" } }, "checks": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string" }, "app_id": { "type": [ "integer", "null" ] } }, "required": [ "context", "app_id" ] } }, "contexts_url": { "type": "string" }, "strict": { "type": "boolean" } }, "required": [ "contexts", "checks" ] }, "enforce_admins": { "title": "Protected Branch Admin Enforced", "description": "Protected Branch Admin Enforced", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, "enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "url", "enabled" ] }, "required_pull_request_reviews": { "title": "Protected Branch Pull Request Review", "description": "Protected Branch Pull Request Review", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" ] }, "dismissal_restrictions": { "type": "object", "properties": { "users": { "description": "The list of users with review dismissal access.", "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "description": "The list of teams with review dismissal access.", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "description": "The list of apps with review dismissal access.", "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } }, "url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" ] }, "users_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" ] }, "teams_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" ] } } }, "bypass_pull_request_allowances": { "type": "object", "description": "Allow specific users, teams, or apps to bypass pull request requirements.", "properties": { "users": { "description": "The list of users allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "description": "The list of teams allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "description": "The list of apps allowed to bypass pull request requirements.", "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } } }, "dismiss_stale_reviews": { "type": "boolean", "examples": [ true ] }, "require_code_owner_reviews": { "type": "boolean", "examples": [ true ] }, "required_approving_review_count": { "type": "integer", "minimum": 0, "maximum": 6, "examples": [ 2 ] } }, "required": [ "dismiss_stale_reviews", "require_code_owner_reviews" ] }, "restrictions": { "title": "Branch Restriction Policy", "description": "Branch Restriction Policy", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "users_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "apps_url": { "type": "string", "format": "uri" }, "users": { "type": "array", "items": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } } }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "members_url": { "type": "string" }, "repositories_url": { "type": "string" }, "parent": { "type": [ "string", "null" ] } } } }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "node_id": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "hooks_url": { "type": "string" }, "issues_url": { "type": "string" }, "members_url": { "type": "string" }, "public_members_url": { "type": "string" }, "avatar_url": { "type": "string" }, "description": { "type": "string" }, "gravatar_id": { "type": "string", "examples": [ "\"\"" ] }, "html_url": { "type": "string", "examples": [ "\"https://github.com/testorg-ea8ec76d71c3af4b\"" ] }, "followers_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" ] }, "following_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" ] }, "gists_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" ] }, "starred_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" ] }, "subscriptions_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" ] }, "organizations_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" ] }, "received_events_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" ] }, "type": { "type": "string", "examples": [ "\"Organization\"" ] }, "site_admin": { "type": "boolean", "examples": [ false ] } } }, "name": { "type": "string" }, "description": { "type": "string" }, "external_url": { "type": "string" }, "html_url": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "metadata": { "type": "string" }, "contents": { "type": "string" }, "issues": { "type": "string" }, "single_file": { "type": "string" } } }, "events": { "type": "array", "items": { "type": "string" } } } } } }, "required": [ "url", "users_url", "teams_url", "apps_url", "users", "teams", "apps" ] }, "required_linear_history": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "allow_force_pushes": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "allow_deletions": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "block_creations": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "required_conversation_resolution": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "name": { "type": "string", "examples": [ "\"branch/with/protection\"" ] }, "protection_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" ] }, "required_signatures": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" ] }, "enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "url", "enabled" ] } } }, "protection_url": { "type": "string", "format": "uri" }, "pattern": { "type": "string", "examples": [ "\"mas*\"" ] }, "required_approving_review_count": { "type": "integer", "examples": [ 1 ] } }, "required": [ "name", "commit", "_links", "protection", "protected", "protection_url" ] } } } ], "previews": [], "descriptionHTML": "Renames a branch in a repository.
\nNote: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe permissions required to use this endpoint depends on whether you are renaming the default branch.
\nTo rename a non-default branch:
\n- \n
- Users must have push access. \n
- GitHub Apps must have the
contents:writerepository permission. \n
To rename the default branch:
\n- \n
- Users must have admin or owner permissions. \n
- GitHub Apps must have the
administration:writerepository permission. \n
Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/merge-upstream", "title": "Sync a fork branch with the upstream repository", "category": "branches", "subcategory": "branches", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "branch", "in": "body", "description": "The name of the branch which should be updated to match upstream.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "branch": "main" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "The branch has been successfully synced with the upstream repository
", "example": { "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", "merge_type": "fast-forward", "base_branch": "defunkt:main" }, "schema": { "title": "Merged upstream", "description": "Results of a successful merge upstream request", "type": "object", "properties": { "message": { "type": "string" }, "merge_type": { "type": "string", "enum": [ "merge", "fast-forward", "none" ] }, "base_branch": { "type": "string" } } } } } ], "previews": [], "descriptionHTML": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "The branch has been successfully synced with the upstream repository
" }, { "httpStatusCode": "409", "description": "The branch could not be synced because of a merge conflict
" }, { "httpStatusCode": "422", "description": "The branch could not be synced for some other reason
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/merges", "title": "Merge a branch", "category": "branches", "subcategory": "branches", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "base", "in": "body", "description": "The name of the base branch that the head will be merged into.
", "isRequired": true }, { "type": "string", "name": "head", "in": "body", "description": "The head to merge. This can be a branch name or a commit SHA1.
", "isRequired": true }, { "type": "string", "name": "commit_message", "in": "body", "description": "Commit message to use for the merge commit. If omitted, a default message will be used.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "base": "master", "head": "cool_feature", "commit_message": "Shipped cool_feature!" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Successful Response (The resulting merge commit)
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", "commit": { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "author": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "committer": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "message": "Fix all the bugs", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" }, "comment_count": 0, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "committer": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" } ], "stats": { "additions": 104, "deletions": 4, "total": 108 }, "files": [ { "filename": "file1.txt", "additions": 10, "deletions": 2, "changes": 12, "status": "modified", "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", "patch": "@@ -29,7 +29,7 @@\n....." } ] }, "schema": { "title": "Commit", "description": "Commit", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "sha": { "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "node_id": { "type": "string", "examples": [ "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" ] }, "commit": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "message": { "type": "string", "examples": [ "Fix all the bugs" ] }, "comment_count": { "type": "integer", "examples": [ 0 ] }, "tree": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "827efc6d56897b048c772eb4087f854f46256132" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" ] } }, "required": [ "sha", "url" ] }, "verification": { "title": "Verification", "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "payload": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "payload", "signature" ] } }, "required": [ "author", "committer", "comment_count", "message", "tree", "url" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" ] } }, "required": [ "sha", "url" ] } }, "stats": { "type": "object", "properties": { "additions": { "type": "integer" }, "deletions": { "type": "integer" }, "total": { "type": "integer" } } }, "files": { "type": "array", "items": { "title": "Diff Entry", "description": "Diff Entry", "type": "object", "properties": { "sha": { "type": "string", "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] }, "filename": { "type": "string", "examples": [ "file1.txt" ] }, "status": { "type": "string", "enum": [ "added", "removed", "modified", "renamed", "copied", "changed", "unchanged" ], "examples": [ "added" ] }, "additions": { "type": "integer", "examples": [ 103 ] }, "deletions": { "type": "integer", "examples": [ 21 ] }, "changes": { "type": "integer", "examples": [ 124 ] }, "blob_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "raw_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "contents_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "patch": { "type": "string", "examples": [ "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" ] }, "previous_filename": { "type": "string", "examples": [ "file.txt" ] } }, "required": [ "additions", "blob_url", "changes", "contents_url", "deletions", "filename", "raw_url", "sha", "status" ] } } }, "required": [ "url", "sha", "node_id", "html_url", "comments_url", "commit", "author", "committer", "parents" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Successful Response (The resulting merge commit)
" }, { "httpStatusCode": "204", "description": "Response when already merged
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Not Found when the base or head does not exist
" }, { "httpStatusCode": "409", "description": "Conflict when there is a merge conflict
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "branch-protection": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", "title": "Get branch protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", "required_status_checks": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "contexts": [ "continuous-integration/travis-ci" ], "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", "enforcement_level": "non_admins" }, "enforce_admins": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true }, "required_pull_request_reviews": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", "users": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "teams": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "apps": [ { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] } ] }, "dismiss_stale_reviews": true, "require_code_owner_reviews": true, "required_approving_review_count": 2 }, "restrictions": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", "users": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "teams": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "apps": [ { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] } ] }, "required_linear_history": { "enabled": true }, "allow_force_pushes": { "enabled": true }, "allow_deletions": { "enabled": true }, "required_conversation_resolution": { "enabled": true } }, "schema": { "title": "Branch Protection", "description": "Branch Protection", "type": "object", "properties": { "url": { "type": "string" }, "enabled": { "type": "boolean" }, "required_status_checks": { "title": "Protected Branch Required Status Check", "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { "type": "string" }, "enforcement_level": { "type": "string" }, "contexts": { "type": "array", "items": { "type": "string" } }, "checks": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string" }, "app_id": { "type": [ "integer", "null" ] } }, "required": [ "context", "app_id" ] } }, "contexts_url": { "type": "string" }, "strict": { "type": "boolean" } }, "required": [ "contexts", "checks" ] }, "enforce_admins": { "title": "Protected Branch Admin Enforced", "description": "Protected Branch Admin Enforced", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, "enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "url", "enabled" ] }, "required_pull_request_reviews": { "title": "Protected Branch Pull Request Review", "description": "Protected Branch Pull Request Review", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" ] }, "dismissal_restrictions": { "type": "object", "properties": { "users": { "description": "The list of users with review dismissal access.", "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "description": "The list of teams with review dismissal access.", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "description": "The list of apps with review dismissal access.", "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } }, "url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" ] }, "users_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" ] }, "teams_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" ] } } }, "bypass_pull_request_allowances": { "type": "object", "description": "Allow specific users, teams, or apps to bypass pull request requirements.", "properties": { "users": { "description": "The list of users allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "description": "The list of teams allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "description": "The list of apps allowed to bypass pull request requirements.", "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } } }, "dismiss_stale_reviews": { "type": "boolean", "examples": [ true ] }, "require_code_owner_reviews": { "type": "boolean", "examples": [ true ] }, "required_approving_review_count": { "type": "integer", "minimum": 0, "maximum": 6, "examples": [ 2 ] } }, "required": [ "dismiss_stale_reviews", "require_code_owner_reviews" ] }, "restrictions": { "title": "Branch Restriction Policy", "description": "Branch Restriction Policy", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "users_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "apps_url": { "type": "string", "format": "uri" }, "users": { "type": "array", "items": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } } }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "members_url": { "type": "string" }, "repositories_url": { "type": "string" }, "parent": { "type": [ "string", "null" ] } } } }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "node_id": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "hooks_url": { "type": "string" }, "issues_url": { "type": "string" }, "members_url": { "type": "string" }, "public_members_url": { "type": "string" }, "avatar_url": { "type": "string" }, "description": { "type": "string" }, "gravatar_id": { "type": "string", "examples": [ "\"\"" ] }, "html_url": { "type": "string", "examples": [ "\"https://github.com/testorg-ea8ec76d71c3af4b\"" ] }, "followers_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" ] }, "following_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" ] }, "gists_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" ] }, "starred_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" ] }, "subscriptions_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" ] }, "organizations_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" ] }, "received_events_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" ] }, "type": { "type": "string", "examples": [ "\"Organization\"" ] }, "site_admin": { "type": "boolean", "examples": [ false ] } } }, "name": { "type": "string" }, "description": { "type": "string" }, "external_url": { "type": "string" }, "html_url": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "metadata": { "type": "string" }, "contents": { "type": "string" }, "issues": { "type": "string" }, "single_file": { "type": "string" } } }, "events": { "type": "array", "items": { "type": "string" } } } } } }, "required": [ "url", "users_url", "teams_url", "apps_url", "users", "teams", "apps" ] }, "required_linear_history": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "allow_force_pushes": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "allow_deletions": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "block_creations": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "required_conversation_resolution": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "name": { "type": "string", "examples": [ "\"branch/with/protection\"" ] }, "protection_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" ] }, "required_signatures": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" ] }, "enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "url", "enabled" ] } } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", "title": "Update branch protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "object or null", "name": "required_status_checks", "in": "body", "description": "Require status checks to pass before merging. Set to null to disable.
Require branches to be up to date before merging.
", "isRequired": true }, { "type": "array of strings", "name": "contexts", "description": "Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "childParamsGroups": [ { "type": "string", "name": "context", "description": "The name of the required check
", "isRequired": true }, { "type": "integer", "name": "app_id", "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.
" } ] } ] }, { "type": "boolean or null", "name": "enforce_admins", "in": "body", "description": "Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
Require at least one approving review on a pull request, before merging. Set to null to disable.
Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.
The list of user logins with dismissal access
The list of team slugs with dismissal access
The list of app slugs with dismissal access
Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.
Blocks merging pull requests until code owners review them.
" }, { "type": "integer", "name": "required_approving_review_count", "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.
" }, { "type": "object", "name": "bypass_pull_request_allowances", "description": "Allow specific users, teams, or apps to bypass pull request requirements.
", "childParamsGroups": [ { "type": "array of strings", "name": "users", "description": "The list of user logins allowed to bypass pull request requirements.
The list of team slugs allowed to bypass pull request requirements.
The list of app slugs allowed to bypass pull request requirements.
Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.
The list of user logins with push access
The list of team slugs with push access
The list of app slugs with push access
Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.
Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"
Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.
If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.
Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.
Response
", "example": { "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", "required_status_checks": { "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", "strict": true, "contexts": [ "continuous-integration/travis-ci" ], "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", "checks": [ { "context": "continuous-integration/travis-ci", "app_id": null } ] }, "restrictions": { "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", "users": [], "teams": [], "apps": [] }, "required_pull_request_reviews": { "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", "dismiss_stale_reviews": true, "require_code_owner_reviews": true, "required_approving_review_count": 2, "dismissal_restrictions": { "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", "users": [], "teams": [], "apps": [] } }, "required_signatures": { "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", "enabled": false }, "enforce_admins": { "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", "enabled": true }, "required_linear_history": { "enabled": true }, "allow_force_pushes": { "enabled": true }, "allow_deletions": { "enabled": true }, "block_creations": { "enabled": true }, "required_conversation_resolution": { "enabled": true } }, "schema": { "title": "Protected Branch", "description": "Branch protections protect branches", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "required_status_checks": { "title": "Status Check Policy", "description": "Status Check Policy", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" ] }, "strict": { "type": "boolean", "examples": [ true ] }, "contexts": { "type": "array", "items": { "type": "string" }, "examples": [ "continuous-integration/travis-ci" ] }, "checks": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string", "examples": [ "continuous-integration/travis-ci" ] }, "app_id": { "type": [ "integer", "null" ] } }, "required": [ "context", "app_id" ] } }, "contexts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" ] } }, "required": [ "url", "contexts_url", "strict", "contexts", "checks" ] }, "required_pull_request_reviews": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "dismiss_stale_reviews": { "type": "boolean" }, "require_code_owner_reviews": { "type": "boolean" }, "required_approving_review_count": { "type": "integer" }, "dismissal_restrictions": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "users_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "users": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } }, "required": [ "url", "users_url", "teams_url", "users", "teams" ] }, "bypass_pull_request_allowances": { "type": "object", "properties": { "users": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } }, "required": [ "users", "teams" ] } }, "required": [ "url" ] }, "required_signatures": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" ] }, "enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "url", "enabled" ] }, "enforce_admins": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "enabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "url", "enabled" ] }, "required_linear_history": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "enabled" ] }, "allow_force_pushes": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "enabled" ] }, "allow_deletions": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "enabled" ] }, "restrictions": { "title": "Branch Restriction Policy", "description": "Branch Restriction Policy", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "users_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "apps_url": { "type": "string", "format": "uri" }, "users": { "type": "array", "items": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } } }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "members_url": { "type": "string" }, "repositories_url": { "type": "string" }, "parent": { "type": [ "string", "null" ] } } } }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "node_id": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "hooks_url": { "type": "string" }, "issues_url": { "type": "string" }, "members_url": { "type": "string" }, "public_members_url": { "type": "string" }, "avatar_url": { "type": "string" }, "description": { "type": "string" }, "gravatar_id": { "type": "string", "examples": [ "\"\"" ] }, "html_url": { "type": "string", "examples": [ "\"https://github.com/testorg-ea8ec76d71c3af4b\"" ] }, "followers_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" ] }, "following_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" ] }, "gists_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" ] }, "starred_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" ] }, "subscriptions_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" ] }, "organizations_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" ] }, "received_events_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" ] }, "type": { "type": "string", "examples": [ "\"Organization\"" ] }, "site_admin": { "type": "boolean", "examples": [ false ] } } }, "name": { "type": "string" }, "description": { "type": "string" }, "external_url": { "type": "string" }, "html_url": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "metadata": { "type": "string" }, "contents": { "type": "string" }, "issues": { "type": "string" }, "single_file": { "type": "string" } } }, "events": { "type": "array", "items": { "type": "string" } } } } } }, "required": [ "url", "users_url", "teams_url", "apps_url", "users", "teams", "apps" ] }, "required_conversation_resolution": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false }, "block_creations": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "enabled" ] } }, "required": [ "url" ] } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote: Passing new arrays of users and teams replaces their previous values.
Note: The list of users, apps, and teams in total is limited to 100 items.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", "title": "Delete branch protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "title": "Get admin branch protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true }, "schema": { "title": "Protected Branch Admin Enforced", "description": "Protected Branch Admin Enforced", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, "enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "url", "enabled" ] } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "title": "Set admin branch protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true }, "schema": { "title": "Protected Branch Admin Enforced", "description": "Protected Branch Admin Enforced", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, "enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "url", "enabled" ] } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "title": "Delete admin branch protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "title": "Get pull request review protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", "users": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "teams": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "apps": [ { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] } ] }, "dismiss_stale_reviews": true, "require_code_owner_reviews": true, "required_approving_review_count": 2 }, "schema": { "title": "Protected Branch Pull Request Review", "description": "Protected Branch Pull Request Review", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" ] }, "dismissal_restrictions": { "type": "object", "properties": { "users": { "description": "The list of users with review dismissal access.", "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "description": "The list of teams with review dismissal access.", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "description": "The list of apps with review dismissal access.", "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } }, "url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" ] }, "users_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" ] }, "teams_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" ] } } }, "bypass_pull_request_allowances": { "type": "object", "description": "Allow specific users, teams, or apps to bypass pull request requirements.", "properties": { "users": { "description": "The list of users allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "description": "The list of teams allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "description": "The list of apps allowed to bypass pull request requirements.", "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } } }, "dismiss_stale_reviews": { "type": "boolean", "examples": [ true ] }, "require_code_owner_reviews": { "type": "boolean", "examples": [ true ] }, "required_approving_review_count": { "type": "integer", "minimum": 0, "maximum": 6, "examples": [ 2 ] } }, "required": [ "dismiss_stale_reviews", "require_code_owner_reviews" ] } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "title": "Update pull request review protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "object", "name": "dismissal_restrictions", "in": "body", "description": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.
The list of user logins with dismissal access
The list of team slugs with dismissal access
The list of app slugs with dismissal access
Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.
Blocks merging pull requests until code owners have reviewed.
" }, { "type": "integer", "name": "required_approving_review_count", "in": "body", "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.
" }, { "type": "object", "name": "bypass_pull_request_allowances", "in": "body", "description": "Allow specific users, teams, or apps to bypass pull request requirements.
", "childParamsGroups": [ { "type": "array of strings", "name": "users", "description": "The list of user logins allowed to bypass pull request requirements.
The list of team slugs allowed to bypass pull request requirements.
The list of app slugs allowed to bypass pull request requirements.
Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", "users": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "teams": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "apps": [ { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] } ] }, "dismiss_stale_reviews": true, "require_code_owner_reviews": true, "required_approving_review_count": 2 }, "schema": { "title": "Protected Branch Pull Request Review", "description": "Protected Branch Pull Request Review", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" ] }, "dismissal_restrictions": { "type": "object", "properties": { "users": { "description": "The list of users with review dismissal access.", "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "description": "The list of teams with review dismissal access.", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "description": "The list of apps with review dismissal access.", "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } }, "url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" ] }, "users_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" ] }, "teams_url": { "type": "string", "examples": [ "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" ] } } }, "bypass_pull_request_allowances": { "type": "object", "description": "Allow specific users, teams, or apps to bypass pull request requirements.", "properties": { "users": { "description": "The list of users allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "description": "The list of teams allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "apps": { "description": "The list of apps allowed to bypass pull request requirements.", "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } } }, "dismiss_stale_reviews": { "type": "boolean", "examples": [ true ] }, "require_code_owner_reviews": { "type": "boolean", "examples": [ true ] }, "required_approving_review_count": { "type": "integer", "minimum": 0, "maximum": 6, "examples": [ 2 ] } }, "required": [ "dismiss_stale_reviews", "require_code_owner_reviews" ] } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote: Passing new arrays of users and teams replaces their previous values.
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "title": "Delete pull request review protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "title": "Get commit signature protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true }, "schema": { "title": "Protected Branch Admin Enforced", "description": "Protected Branch Admin Enforced", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, "enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "url", "enabled" ] } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note: You must enable branch protection to require signed commits.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "title": "Create commit signature protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true }, "schema": { "title": "Protected Branch Admin Enforced", "description": "Protected Branch Admin Enforced", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, "enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "url", "enabled" ] } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "title": "Delete commit signature protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "title": "Get status checks protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, "contexts": [ "continuous-integration/travis-ci" ], "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" }, "schema": { "title": "Status Check Policy", "description": "Status Check Policy", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" ] }, "strict": { "type": "boolean", "examples": [ true ] }, "contexts": { "type": "array", "items": { "type": "string" }, "examples": [ "continuous-integration/travis-ci" ] }, "checks": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string", "examples": [ "continuous-integration/travis-ci" ] }, "app_id": { "type": [ "integer", "null" ] } }, "required": [ "context", "app_id" ] } }, "contexts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" ] } }, "required": [ "url", "contexts_url", "strict", "contexts", "checks" ] } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "title": "Update status check protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "boolean", "name": "strict", "in": "body", "description": "Require branches to be up to date before merging.
" }, { "type": "array of strings", "name": "contexts", "in": "body", "description": "Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "childParamsGroups": [ { "type": "string", "name": "context", "description": "The name of the required check
", "isRequired": true }, { "type": "integer", "name": "app_id", "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.
" } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "strict": true, "contexts": [ "continuous-integration/travis-ci" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, "contexts": [ "continuous-integration/travis-ci" ], "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" }, "schema": { "title": "Status Check Policy", "description": "Status Check Policy", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" ] }, "strict": { "type": "boolean", "examples": [ true ] }, "contexts": { "type": "array", "items": { "type": "string" }, "examples": [ "continuous-integration/travis-ci" ] }, "checks": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string", "examples": [ "continuous-integration/travis-ci" ] }, "app_id": { "type": [ "integer", "null" ] } }, "required": [ "context", "app_id" ] } }, "contexts_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" ] } }, "required": [ "url", "contexts_url", "strict", "contexts", "checks" ] } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "title": "Remove status check protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "title": "Get all status check contexts", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ "continuous-integration/travis-ci" ], "schema": { "type": "array", "items": { "type": "string" } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "title": "Add status check contexts", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "array of strings", "name": "contexts", "in": "body", "description": "The name of the status checks
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "contexts": [ "continuous-integration/travis-ci", "continuous-integration/jenkins" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ "continuous-integration/travis-ci", "continuous-integration/jenkins" ], "schema": { "type": "array", "items": { "type": "string" } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "title": "Set status check contexts", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "array of strings", "name": "contexts", "in": "body", "description": "The name of the status checks
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "contexts": [ "continuous-integration/travis-ci" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ "continuous-integration/travis-ci" ], "schema": { "type": "array", "items": { "type": "string" } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "title": "Remove status check contexts", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "array of strings", "name": "contexts", "in": "body", "description": "The name of the status checks
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "contexts": [ "continuous-integration/travis-ci" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ "continuous-integration/travis-ci" ], "schema": { "type": "array", "items": { "type": "string" } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "title": "Get access restrictions", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", "users": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "teams": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "apps": [ { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] } ] }, "schema": { "title": "Branch Restriction Policy", "description": "Branch Restriction Policy", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "users_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "apps_url": { "type": "string", "format": "uri" }, "users": { "type": "array", "items": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } } }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "members_url": { "type": "string" }, "repositories_url": { "type": "string" }, "parent": { "type": [ "string", "null" ] } } } }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "node_id": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "hooks_url": { "type": "string" }, "issues_url": { "type": "string" }, "members_url": { "type": "string" }, "public_members_url": { "type": "string" }, "avatar_url": { "type": "string" }, "description": { "type": "string" }, "gravatar_id": { "type": "string", "examples": [ "\"\"" ] }, "html_url": { "type": "string", "examples": [ "\"https://github.com/testorg-ea8ec76d71c3af4b\"" ] }, "followers_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" ] }, "following_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" ] }, "gists_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" ] }, "starred_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" ] }, "subscriptions_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" ] }, "organizations_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" ] }, "received_events_url": { "type": "string", "examples": [ "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" ] }, "type": { "type": "string", "examples": [ "\"Organization\"" ] }, "site_admin": { "type": "boolean", "examples": [ false ] } } }, "name": { "type": "string" }, "description": { "type": "string" }, "external_url": { "type": "string" }, "html_url": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "metadata": { "type": "string" }, "contents": { "type": "string" }, "issues": { "type": "string" }, "single_file": { "type": "string" } } }, "events": { "type": "array", "items": { "type": "string" } } } } } }, "required": [ "url", "users_url", "teams_url", "apps_url", "users", "teams", "apps" ] } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote: Users, apps, and teams restrictions are only available for organization-owned repositories.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "title": "Delete access restrictions", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nDisables the ability to restrict who can push to this branch.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "title": "Get apps with access to the protected branch", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] } ], "schema": { "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "title": "Add app access restrictions", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "array of strings", "name": "apps", "in": "body", "description": "apps parameter
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] } ], "schema": { "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "title": "Set app access restrictions", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "array of strings", "name": "apps", "in": "body", "description": "apps parameter
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] } ], "schema": { "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "title": "Remove app access restrictions", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "array of strings", "name": "apps", "in": "body", "description": "apps parameter
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] } ], "schema": { "type": "array", "items": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "title": "Get teams with access to the protected branch", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "schema": { "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "title": "Add team access restrictions", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "array of strings", "name": "teams", "in": "body", "description": "The slug values for teams
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "teams": [ "justice-league" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "schema": { "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified teams push access for this branch. You can also give push access to child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "title": "Set team access restrictions", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "array of strings", "name": "teams", "in": "body", "description": "The slug values for teams
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "teams": [ "justice-league" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "schema": { "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "title": "Remove team access restrictions", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "array of strings", "name": "teams", "in": "body", "description": "The slug values for teams
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "teams": [ "justice-league" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "schema": { "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Teams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "title": "Get users with access to the protected branch", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the people who have push access to this branch.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "title": "Add user access restrictions", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "array of strings", "name": "users", "in": "body", "description": "The username for users
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "users": [ "octocat" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "title": "Set user access restrictions", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "array of strings", "name": "users", "in": "body", "description": "The username for users
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "users": [ "octocat" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "title": "Remove user access restrictions", "category": "branches", "subcategory": "branch-protection", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "description": "The name of the branch.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "array of strings", "name": "users", "in": "body", "description": "The username for users
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "users": [ "octocat" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "branch": "BRANCH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ] }, "checks": { "runs": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-runs", "title": "Create a check run", "category": "checks", "subcategory": "runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name of the check. For example, \"code-coverage\".
", "isRequired": true }, { "type": "string", "name": "head_sha", "in": "body", "description": "The SHA of the commit.
", "isRequired": true }, { "type": "string", "name": "details_url", "in": "body", "description": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.
" }, { "type": "string", "name": "external_id", "in": "body", "description": "A reference for the run on the integrator's system.
" }, { "type": "string", "name": "status", "in": "body", "description": "The current status.
", "enum": [ "queued", "in_progress", "completed" ], "default": "queued" }, { "type": "string", "name": "started_at", "in": "body", "description": "The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.
The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.
The title of the check run.
", "isRequired": true }, { "type": "string", "name": "summary", "description": "The summary of the check run. This parameter supports Markdown.
", "isRequired": true }, { "type": "string", "name": "text", "description": "The details of the check run. This parameter supports Markdown.
" }, { "type": "array of objects", "name": "annotations", "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.
The path of the file to add an annotation to. For example, assets/css/main.css.
The start line of the annotation.
", "isRequired": true }, { "type": "integer", "name": "end_line", "description": "The end line of the annotation.
", "isRequired": true }, { "type": "integer", "name": "start_column", "description": "The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.
The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.
The level of the annotation.
", "isRequired": true, "enum": [ "notice", "warning", "failure" ] }, { "type": "string", "name": "message", "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.
", "isRequired": true }, { "type": "string", "name": "title", "description": "The title that represents the annotation. The maximum size is 255 characters.
" }, { "type": "string", "name": "raw_details", "description": "Details about this annotation. The maximum size is 64 KB.
" } ] }, { "type": "array of objects", "name": "images", "description": "Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.
The alternative text for the image.
", "isRequired": true }, { "type": "string", "name": "image_url", "description": "The full URL of the image.
", "isRequired": true }, { "type": "string", "name": "caption", "description": "A short image description.
" } ] } ] }, { "type": "array of objects", "name": "actions", "in": "body", "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
The text to be displayed on a button in the web UI. The maximum size is 20 characters.
", "isRequired": true }, { "type": "string", "name": "description", "description": "A short explanation of what this action would do. The maximum size is 40 characters.
", "isRequired": true }, { "type": "string", "name": "identifier", "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.
", "isRequired": true } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", "description": "Example of an in_progress conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "status": "in_progress", "external_id": "42", "started_at": "2018-05-04T01:14:52Z", "output": { "title": "Mighty Readme report", "summary": "", "text": "" } }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response for in_progress conclusion
", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "node_id": "MDg6Q2hlY2tSdW40", "external_id": "42", "url": "https://api.github.com/repos/github/hello-world/check-runs/4", "html_url": "https://github.com/github/hello-world/runs/4", "details_url": "https://example.com", "status": "in_progress", "conclusion": null, "started_at": "2018-05-04T01:14:52Z", "completed_at": null, "output": { "title": "Mighty Readme report", "summary": "There are 0 failures, 2 warnings, and 1 notice.", "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", "annotations_count": 2, "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" }, "name": "mighty_readme", "check_suite": { "id": 5 }, "app": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] }, "pull_requests": [ { "url": "https://api.github.com/repos/github/hello-world/pulls/1", "id": 1934, "number": 3956, "head": { "ref": "say-hello", "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", "repo": { "id": 526, "url": "https://api.github.com/repos/github/hello-world", "name": "hello-world" } }, "base": { "ref": "master", "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", "repo": { "id": 526, "url": "https://api.github.com/repos/github/hello-world", "name": "hello-world" } } } ] }, "schema": { "title": "CheckRun", "description": "A check performed on the code of a given code change", "type": "object", "properties": { "id": { "description": "The id of the check.", "type": "integer", "examples": [ 21 ] }, "head_sha": { "description": "The SHA of the commit that is being checked.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "node_id": { "type": "string", "examples": [ "MDg6Q2hlY2tSdW40" ] }, "external_id": { "type": [ "string", "null" ], "examples": [ "42" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-runs/4" ] }, "html_url": { "type": [ "string", "null" ], "examples": [ "https://github.com/github/hello-world/runs/4" ] }, "details_url": { "type": [ "string", "null" ], "examples": [ "https://example.com" ] }, "status": { "description": "The phase of the lifecycle that the check is currently in.", "type": "string", "enum": [ "queued", "in_progress", "completed" ], "examples": [ "queued" ] }, "conclusion": { "type": [ "string", "null" ], "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ], "examples": [ "neutral" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2018-05-04T01:14:52Z" ] }, "completed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2018-05-04T01:14:52Z" ] }, "output": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] }, "annotations_count": { "type": "integer" }, "annotations_url": { "type": "string", "format": "uri" } }, "required": [ "title", "summary", "text", "annotations_count", "annotations_url" ] }, "name": { "description": "The name of the check.", "type": "string", "examples": [ "test-coverage" ] }, "check_suite": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" } }, "required": [ "id" ] }, "app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "pull_requests": { "type": "array", "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "deployment": { "title": "Deployment", "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1" ] }, "id": { "description": "Unique identifier of the deployment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkRlcGxveW1lbnQx" ] }, "task": { "description": "Parameter to specify a task to execute", "type": "string", "examples": [ "deploy" ] }, "original_environment": { "type": "string", "examples": [ "staging" ] }, "environment": { "description": "Name for the target deployment environment.", "type": "string", "examples": [ "production" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Deploy request from hubot" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] }, "transient_environment": { "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", "type": "boolean", "examples": [ true ] }, "production_environment": { "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", "type": "boolean", "examples": [ true ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "task", "environment", "description", "statuses_url", "repository_url", "url", "created_at", "updated_at" ] } }, "required": [ "id", "node_id", "head_sha", "name", "url", "html_url", "details_url", "status", "conclusion", "started_at", "completed_at", "external_id", "check_suite", "output", "app", "pull_requests" ] } } }, { "key": "example-of-completed-conclusion", "request": { "contentType": "application/json", "description": "Example of a completed conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "status": "completed", "started_at": "2017-11-30T19:39:10Z", "conclusion": "success", "completed_at": "2017-11-30T19:49:10Z", "output": { "title": "Mighty Readme report", "summary": "There are 0 failures, 2 warnings, and 1 notices.", "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", "annotations": [ { "path": "README.md", "annotation_level": "warning", "title": "Spell Checker", "message": "Check your spelling for 'banaas'.", "raw_details": "Do you mean 'bananas' or 'banana'?", "start_line": 2, "end_line": 2 }, { "path": "README.md", "annotation_level": "warning", "title": "Spell Checker", "message": "Check your spelling for 'aples'", "raw_details": "Do you mean 'apples' or 'Naples'", "start_line": 4, "end_line": 4 } ], "images": [ { "alt": "Super bananas", "image_url": "http://example.com/images/42" } ] }, "actions": [ { "label": "Fix", "identifier": "fix_errors", "description": "Allow us to fix these errors for you" } ] }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response for completed conclusion
", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "node_id": "MDg6Q2hlY2tSdW40", "external_id": "42", "url": "https://api.github.com/repos/github/hello-world/check-runs/4", "html_url": "https://github.com/github/hello-world/runs/4", "details_url": "https://example.com", "status": "completed", "conclusion": "neutral", "started_at": "2018-05-04T01:14:52Z", "completed_at": "2018-05-04T01:14:52Z", "output": { "title": "Mighty Readme report", "summary": "There are 0 failures, 2 warnings, and 1 notice.", "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", "annotations_count": 2, "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" }, "name": "mighty_readme", "check_suite": { "id": 5 }, "app": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] }, "pull_requests": [ { "url": "https://api.github.com/repos/github/hello-world/pulls/1", "id": 1934, "number": 3956, "head": { "ref": "say-hello", "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", "repo": { "id": 526, "url": "https://api.github.com/repos/github/hello-world", "name": "hello-world" } }, "base": { "ref": "master", "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", "repo": { "id": 526, "url": "https://api.github.com/repos/github/hello-world", "name": "hello-world" } } } ] }, "schema": { "title": "CheckRun", "description": "A check performed on the code of a given code change", "type": "object", "properties": { "id": { "description": "The id of the check.", "type": "integer", "examples": [ 21 ] }, "head_sha": { "description": "The SHA of the commit that is being checked.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "node_id": { "type": "string", "examples": [ "MDg6Q2hlY2tSdW40" ] }, "external_id": { "type": [ "string", "null" ], "examples": [ "42" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-runs/4" ] }, "html_url": { "type": [ "string", "null" ], "examples": [ "https://github.com/github/hello-world/runs/4" ] }, "details_url": { "type": [ "string", "null" ], "examples": [ "https://example.com" ] }, "status": { "description": "The phase of the lifecycle that the check is currently in.", "type": "string", "enum": [ "queued", "in_progress", "completed" ], "examples": [ "queued" ] }, "conclusion": { "type": [ "string", "null" ], "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ], "examples": [ "neutral" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2018-05-04T01:14:52Z" ] }, "completed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2018-05-04T01:14:52Z" ] }, "output": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] }, "annotations_count": { "type": "integer" }, "annotations_url": { "type": "string", "format": "uri" } }, "required": [ "title", "summary", "text", "annotations_count", "annotations_url" ] }, "name": { "description": "The name of the check.", "type": "string", "examples": [ "test-coverage" ] }, "check_suite": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" } }, "required": [ "id" ] }, "app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "pull_requests": { "type": "array", "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "deployment": { "title": "Deployment", "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1" ] }, "id": { "description": "Unique identifier of the deployment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkRlcGxveW1lbnQx" ] }, "task": { "description": "Parameter to specify a task to execute", "type": "string", "examples": [ "deploy" ] }, "original_environment": { "type": "string", "examples": [ "staging" ] }, "environment": { "description": "Name for the target deployment environment.", "type": "string", "examples": [ "production" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Deploy request from hubot" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] }, "transient_environment": { "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", "type": "boolean", "examples": [ true ] }, "production_environment": { "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", "type": "boolean", "examples": [ true ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "task", "environment", "description", "statuses_url", "repository_url", "url", "created_at", "updated_at" ] } }, "required": [ "id", "node_id", "head_sha", "name", "url", "html_url", "details_url", "status", "conclusion", "started_at", "completed_at", "external_id", "check_suite", "output", "app", "pull_requests" ] } } } ], "previews": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", "title": "Get a check run", "category": "checks", "subcategory": "runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "check_run_id", "description": "The unique identifier of the check run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "check_run_id": "CHECK_RUN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "node_id": "MDg6Q2hlY2tSdW40", "external_id": "", "url": "https://api.github.com/repos/github/hello-world/check-runs/4", "html_url": "https://github.com/github/hello-world/runs/4", "details_url": "https://example.com", "status": "completed", "conclusion": "neutral", "started_at": "2018-05-04T01:14:52Z", "completed_at": "2018-05-04T01:14:52Z", "output": { "title": "Mighty Readme report", "summary": "There are 0 failures, 2 warnings, and 1 notice.", "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", "annotations_count": 2, "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" }, "name": "mighty_readme", "check_suite": { "id": 5 }, "app": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] }, "pull_requests": [ { "url": "https://api.github.com/repos/github/hello-world/pulls/1", "id": 1934, "number": 3956, "head": { "ref": "say-hello", "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", "repo": { "id": 526, "url": "https://api.github.com/repos/github/hello-world", "name": "hello-world" } }, "base": { "ref": "master", "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", "repo": { "id": 526, "url": "https://api.github.com/repos/github/hello-world", "name": "hello-world" } } } ] }, "schema": { "title": "CheckRun", "description": "A check performed on the code of a given code change", "type": "object", "properties": { "id": { "description": "The id of the check.", "type": "integer", "examples": [ 21 ] }, "head_sha": { "description": "The SHA of the commit that is being checked.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "node_id": { "type": "string", "examples": [ "MDg6Q2hlY2tSdW40" ] }, "external_id": { "type": [ "string", "null" ], "examples": [ "42" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-runs/4" ] }, "html_url": { "type": [ "string", "null" ], "examples": [ "https://github.com/github/hello-world/runs/4" ] }, "details_url": { "type": [ "string", "null" ], "examples": [ "https://example.com" ] }, "status": { "description": "The phase of the lifecycle that the check is currently in.", "type": "string", "enum": [ "queued", "in_progress", "completed" ], "examples": [ "queued" ] }, "conclusion": { "type": [ "string", "null" ], "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ], "examples": [ "neutral" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2018-05-04T01:14:52Z" ] }, "completed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2018-05-04T01:14:52Z" ] }, "output": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] }, "annotations_count": { "type": "integer" }, "annotations_url": { "type": "string", "format": "uri" } }, "required": [ "title", "summary", "text", "annotations_count", "annotations_url" ] }, "name": { "description": "The name of the check.", "type": "string", "examples": [ "test-coverage" ] }, "check_suite": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" } }, "required": [ "id" ] }, "app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "pull_requests": { "type": "array", "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "deployment": { "title": "Deployment", "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1" ] }, "id": { "description": "Unique identifier of the deployment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkRlcGxveW1lbnQx" ] }, "task": { "description": "Parameter to specify a task to execute", "type": "string", "examples": [ "deploy" ] }, "original_environment": { "type": "string", "examples": [ "staging" ] }, "environment": { "description": "Name for the target deployment environment.", "type": "string", "examples": [ "production" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Deploy request from hubot" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] }, "transient_environment": { "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", "type": "boolean", "examples": [ true ] }, "production_environment": { "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", "type": "boolean", "examples": [ true ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "task", "environment", "description", "statuses_url", "repository_url", "url", "created_at", "updated_at" ] } }, "required": [ "id", "node_id", "head_sha", "name", "url", "html_url", "details_url", "status", "conclusion", "started_at", "completed_at", "external_id", "check_suite", "output", "app", "pull_requests" ] } } } ], "previews": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", "title": "Update a check run", "category": "checks", "subcategory": "runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "check_run_id", "description": "The unique identifier of the check run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name of the check. For example, \"code-coverage\".
" }, { "type": "string", "name": "details_url", "in": "body", "description": "The URL of the integrator's site that has the full details of the check.
" }, { "type": "string", "name": "external_id", "in": "body", "description": "A reference for the run on the integrator's system.
" }, { "type": "string", "name": "started_at", "in": "body", "description": "This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The current status.
", "enum": [ "queued", "in_progress", "completed" ] }, { "type": "string", "name": "conclusion", "in": "body", "description": "Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.
The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.
Required.
" }, { "type": "string", "name": "summary", "description": "Can contain Markdown.
", "isRequired": true }, { "type": "string", "name": "text", "description": "Can contain Markdown.
" }, { "type": "array of objects", "name": "annotations", "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.
The path of the file to add an annotation to. For example, assets/css/main.css.
The start line of the annotation.
", "isRequired": true }, { "type": "integer", "name": "end_line", "description": "The end line of the annotation.
", "isRequired": true }, { "type": "integer", "name": "start_column", "description": "The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.
The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.
The level of the annotation.
", "isRequired": true, "enum": [ "notice", "warning", "failure" ] }, { "type": "string", "name": "message", "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.
", "isRequired": true }, { "type": "string", "name": "title", "description": "The title that represents the annotation. The maximum size is 255 characters.
" }, { "type": "string", "name": "raw_details", "description": "Details about this annotation. The maximum size is 64 KB.
" } ] }, { "type": "array of objects", "name": "images", "description": "Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.
The alternative text for the image.
", "isRequired": true }, { "type": "string", "name": "image_url", "description": "The full URL of the image.
", "isRequired": true }, { "type": "string", "name": "caption", "description": "A short image description.
" } ] } ] }, { "type": "array of objects", "name": "actions", "in": "body", "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
The text to be displayed on a button in the web UI. The maximum size is 20 characters.
", "isRequired": true }, { "type": "string", "name": "description", "description": "A short explanation of what this action would do. The maximum size is 40 characters.
", "isRequired": true }, { "type": "string", "name": "identifier", "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.
", "isRequired": true } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", "started_at": "2018-05-04T01:14:52Z", "status": "completed", "conclusion": "success", "completed_at": "2018-05-04T01:14:52Z", "output": { "title": "Mighty Readme report", "summary": "There are 0 failures, 2 warnings, and 1 notices.", "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", "annotations": [ { "path": "README.md", "annotation_level": "warning", "title": "Spell Checker", "message": "Check your spelling for 'banaas'.", "raw_details": "Do you mean 'bananas' or 'banana'?", "start_line": 2, "end_line": 2 }, { "path": "README.md", "annotation_level": "warning", "title": "Spell Checker", "message": "Check your spelling for 'aples'", "raw_details": "Do you mean 'apples' or 'Naples'", "start_line": 4, "end_line": 4 } ], "images": [ { "alt": "Super bananas", "image_url": "http://example.com/images/42" } ] } }, "parameters": { "owner": "OWNER", "repo": "REPO", "check_run_id": "CHECK_RUN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "node_id": "MDg6Q2hlY2tSdW40", "external_id": "", "url": "https://api.github.com/repos/github/hello-world/check-runs/4", "html_url": "https://github.com/github/hello-world/runs/4", "details_url": "https://example.com", "status": "completed", "conclusion": "neutral", "started_at": "2018-05-04T01:14:52Z", "completed_at": "2018-05-04T01:14:52Z", "output": { "title": "Mighty Readme report", "summary": "There are 0 failures, 2 warnings, and 1 notice.", "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", "annotations_count": 2, "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" }, "name": "mighty_readme", "check_suite": { "id": 5 }, "app": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] }, "pull_requests": [ { "url": "https://api.github.com/repos/github/hello-world/pulls/1", "id": 1934, "number": 3956, "head": { "ref": "say-hello", "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", "repo": { "id": 526, "url": "https://api.github.com/repos/github/hello-world", "name": "hello-world" } }, "base": { "ref": "master", "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", "repo": { "id": 526, "url": "https://api.github.com/repos/github/hello-world", "name": "hello-world" } } } ] }, "schema": { "title": "CheckRun", "description": "A check performed on the code of a given code change", "type": "object", "properties": { "id": { "description": "The id of the check.", "type": "integer", "examples": [ 21 ] }, "head_sha": { "description": "The SHA of the commit that is being checked.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "node_id": { "type": "string", "examples": [ "MDg6Q2hlY2tSdW40" ] }, "external_id": { "type": [ "string", "null" ], "examples": [ "42" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-runs/4" ] }, "html_url": { "type": [ "string", "null" ], "examples": [ "https://github.com/github/hello-world/runs/4" ] }, "details_url": { "type": [ "string", "null" ], "examples": [ "https://example.com" ] }, "status": { "description": "The phase of the lifecycle that the check is currently in.", "type": "string", "enum": [ "queued", "in_progress", "completed" ], "examples": [ "queued" ] }, "conclusion": { "type": [ "string", "null" ], "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ], "examples": [ "neutral" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2018-05-04T01:14:52Z" ] }, "completed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2018-05-04T01:14:52Z" ] }, "output": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] }, "annotations_count": { "type": "integer" }, "annotations_url": { "type": "string", "format": "uri" } }, "required": [ "title", "summary", "text", "annotations_count", "annotations_url" ] }, "name": { "description": "The name of the check.", "type": "string", "examples": [ "test-coverage" ] }, "check_suite": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" } }, "required": [ "id" ] }, "app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "pull_requests": { "type": "array", "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "deployment": { "title": "Deployment", "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1" ] }, "id": { "description": "Unique identifier of the deployment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkRlcGxveW1lbnQx" ] }, "task": { "description": "Parameter to specify a task to execute", "type": "string", "examples": [ "deploy" ] }, "original_environment": { "type": "string", "examples": [ "staging" ] }, "environment": { "description": "Name for the target deployment environment.", "type": "string", "examples": [ "production" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Deploy request from hubot" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] }, "transient_environment": { "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", "type": "boolean", "examples": [ true ] }, "production_environment": { "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", "type": "boolean", "examples": [ true ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "task", "environment", "description", "statuses_url", "repository_url", "url", "created_at", "updated_at" ] } }, "required": [ "id", "node_id", "head_sha", "name", "url", "html_url", "details_url", "status", "conclusion", "started_at", "completed_at", "external_id", "check_suite", "output", "app", "pull_requests" ] } } } ], "previews": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", "title": "List check run annotations", "category": "checks", "subcategory": "runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "check_run_id", "description": "The unique identifier of the check run.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "check_run_id": "CHECK_RUN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "path": "README.md", "start_line": 2, "end_line": 2, "start_column": 5, "end_column": 10, "annotation_level": "warning", "title": "Spell Checker", "message": "Check your spelling for 'banaas'.", "raw_details": "Do you mean 'bananas' or 'banana'?", "blob_href": "https://api.github.com/repos/github/rest-api-description/git/blobs/abc" } ], "schema": { "type": "array", "items": { "title": "Check Annotation", "description": "Check Annotation", "type": "object", "properties": { "path": { "type": "string", "examples": [ "README.md" ] }, "start_line": { "type": "integer", "examples": [ 2 ] }, "end_line": { "type": "integer", "examples": [ 2 ] }, "start_column": { "type": [ "integer", "null" ], "examples": [ 5 ] }, "end_column": { "type": [ "integer", "null" ], "examples": [ 10 ] }, "annotation_level": { "type": [ "string", "null" ], "examples": [ "warning" ] }, "title": { "type": [ "string", "null" ], "examples": [ "Spell Checker" ] }, "message": { "type": [ "string", "null" ], "examples": [ "Check your spelling for 'banaas'." ] }, "raw_details": { "type": [ "string", "null" ], "examples": [ "Do you mean 'bananas' or 'banana'?" ] }, "blob_href": { "type": "string" } }, "required": [ "path", "blob_href", "start_line", "end_line", "start_column", "end_column", "annotation_level", "title", "message", "raw_details" ] } } } } ], "previews": [], "descriptionHTML": "Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest", "title": "Rerequest a check run", "category": "checks", "subcategory": "runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "check_run_id", "description": "The unique identifier of the check run.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "check_run_id": "CHECK_RUN_ID" } }, "response": { "statusCode": "201", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, its status is reset to queued and the conclusion is cleared.
To rerequest a check run, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.
Created
" }, { "httpStatusCode": "403", "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation error if the check run is not rerequestable
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", "title": "List check runs in a check suite", "category": "checks", "subcategory": "runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "check_suite_id", "description": "The unique identifier of the check suite.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "check_name", "description": "Returns check runs with the specified name.
Returns check runs with the specified status.
Filters check runs by their completed_at timestamp. latest returns the most recent check runs.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "check_suite_id": "CHECK_SUITE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "check_runs": [ { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "node_id": "MDg6Q2hlY2tSdW40", "external_id": "", "url": "https://api.github.com/repos/github/hello-world/check-runs/4", "html_url": "https://github.com/github/hello-world/runs/4", "details_url": "https://example.com", "status": "completed", "conclusion": "neutral", "started_at": "2018-05-04T01:14:52Z", "completed_at": "2018-05-04T01:14:52Z", "output": { "title": "Mighty Readme report", "summary": "There are 0 failures, 2 warnings, and 1 notice.", "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", "annotations_count": 2, "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" }, "name": "mighty_readme", "check_suite": { "id": 5 }, "app": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] }, "pull_requests": [ { "url": "https://api.github.com/repos/github/hello-world/pulls/1", "id": 1934, "number": 3956, "head": { "ref": "say-hello", "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", "repo": { "id": 526, "url": "https://api.github.com/repos/github/hello-world", "name": "hello-world" } }, "base": { "ref": "master", "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", "repo": { "id": 526, "url": "https://api.github.com/repos/github/hello-world", "name": "hello-world" } } } ] } ] }, "schema": { "type": "object", "required": [ "total_count", "check_runs" ], "properties": { "total_count": { "type": "integer" }, "check_runs": { "type": "array", "items": { "title": "CheckRun", "description": "A check performed on the code of a given code change", "type": "object", "properties": { "id": { "description": "The id of the check.", "type": "integer", "examples": [ 21 ] }, "head_sha": { "description": "The SHA of the commit that is being checked.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "node_id": { "type": "string", "examples": [ "MDg6Q2hlY2tSdW40" ] }, "external_id": { "type": [ "string", "null" ], "examples": [ "42" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-runs/4" ] }, "html_url": { "type": [ "string", "null" ], "examples": [ "https://github.com/github/hello-world/runs/4" ] }, "details_url": { "type": [ "string", "null" ], "examples": [ "https://example.com" ] }, "status": { "description": "The phase of the lifecycle that the check is currently in.", "type": "string", "enum": [ "queued", "in_progress", "completed" ], "examples": [ "queued" ] }, "conclusion": { "type": [ "string", "null" ], "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ], "examples": [ "neutral" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2018-05-04T01:14:52Z" ] }, "completed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2018-05-04T01:14:52Z" ] }, "output": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] }, "annotations_count": { "type": "integer" }, "annotations_url": { "type": "string", "format": "uri" } }, "required": [ "title", "summary", "text", "annotations_count", "annotations_url" ] }, "name": { "description": "The name of the check.", "type": "string", "examples": [ "test-coverage" ] }, "check_suite": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" } }, "required": [ "id" ] }, "app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "pull_requests": { "type": "array", "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "deployment": { "title": "Deployment", "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1" ] }, "id": { "description": "Unique identifier of the deployment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkRlcGxveW1lbnQx" ] }, "task": { "description": "Parameter to specify a task to execute", "type": "string", "examples": [ "deploy" ] }, "original_environment": { "type": "string", "examples": [ "staging" ] }, "environment": { "description": "Name for the target deployment environment.", "type": "string", "examples": [ "production" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Deploy request from hubot" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] }, "transient_environment": { "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", "type": "boolean", "examples": [ true ] }, "production_environment": { "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", "type": "boolean", "examples": [ true ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "task", "environment", "description", "statuses_url", "repository_url", "url", "created_at", "updated_at" ] } }, "required": [ "id", "node_id", "head_sha", "name", "url", "html_url", "details_url", "status", "conclusion", "started_at", "completed_at", "external_id", "check_suite", "output", "app", "pull_requests" ] } } } } } } ], "previews": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs", "title": "List check runs for a Git reference", "category": "checks", "subcategory": "runs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ref", "description": "ref parameter
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true }, { "name": "check_name", "description": "Returns check runs with the specified name.
Returns check runs with the specified status.
Filters check runs by their completed_at timestamp. latest returns the most recent check runs.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "app_id", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "check_runs": [ { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "node_id": "MDg6Q2hlY2tSdW40", "external_id": "", "url": "https://api.github.com/repos/github/hello-world/check-runs/4", "html_url": "https://github.com/github/hello-world/runs/4", "details_url": "https://example.com", "status": "completed", "conclusion": "neutral", "started_at": "2018-05-04T01:14:52Z", "completed_at": "2018-05-04T01:14:52Z", "output": { "title": "Mighty Readme report", "summary": "There are 0 failures, 2 warnings, and 1 notice.", "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", "annotations_count": 2, "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" }, "name": "mighty_readme", "check_suite": { "id": 5 }, "app": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] }, "pull_requests": [ { "url": "https://api.github.com/repos/github/hello-world/pulls/1", "id": 1934, "number": 3956, "head": { "ref": "say-hello", "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", "repo": { "id": 526, "url": "https://api.github.com/repos/github/hello-world", "name": "hello-world" } }, "base": { "ref": "master", "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", "repo": { "id": 526, "url": "https://api.github.com/repos/github/hello-world", "name": "hello-world" } } } ] } ] }, "schema": { "type": "object", "required": [ "total_count", "check_runs" ], "properties": { "total_count": { "type": "integer" }, "check_runs": { "type": "array", "items": { "title": "CheckRun", "description": "A check performed on the code of a given code change", "type": "object", "properties": { "id": { "description": "The id of the check.", "type": "integer", "examples": [ 21 ] }, "head_sha": { "description": "The SHA of the commit that is being checked.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "node_id": { "type": "string", "examples": [ "MDg6Q2hlY2tSdW40" ] }, "external_id": { "type": [ "string", "null" ], "examples": [ "42" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-runs/4" ] }, "html_url": { "type": [ "string", "null" ], "examples": [ "https://github.com/github/hello-world/runs/4" ] }, "details_url": { "type": [ "string", "null" ], "examples": [ "https://example.com" ] }, "status": { "description": "The phase of the lifecycle that the check is currently in.", "type": "string", "enum": [ "queued", "in_progress", "completed" ], "examples": [ "queued" ] }, "conclusion": { "type": [ "string", "null" ], "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ], "examples": [ "neutral" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2018-05-04T01:14:52Z" ] }, "completed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2018-05-04T01:14:52Z" ] }, "output": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] }, "annotations_count": { "type": "integer" }, "annotations_url": { "type": "string", "format": "uri" } }, "required": [ "title", "summary", "text", "annotations_count", "annotations_url" ] }, "name": { "description": "The name of the check.", "type": "string", "examples": [ "test-coverage" ] }, "check_suite": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" } }, "required": [ "id" ] }, "app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "pull_requests": { "type": "array", "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "deployment": { "title": "Deployment", "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1" ] }, "id": { "description": "Unique identifier of the deployment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkRlcGxveW1lbnQx" ] }, "task": { "description": "Parameter to specify a task to execute", "type": "string", "examples": [ "deploy" ] }, "original_environment": { "type": "string", "examples": [ "staging" ] }, "environment": { "description": "Name for the target deployment environment.", "type": "string", "examples": [ "production" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Deploy request from hubot" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] }, "transient_environment": { "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", "type": "boolean", "examples": [ true ] }, "production_environment": { "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", "type": "boolean", "examples": [ true ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "task", "environment", "description", "statuses_url", "repository_url", "url", "created_at", "updated_at" ] } }, "required": [ "id", "node_id", "head_sha", "name", "url", "html_url", "details_url", "status", "conclusion", "started_at", "completed_at", "external_id", "check_suite", "output", "app", "pull_requests" ] } } } } } } ], "previews": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
OK
" } ] } ], "suites": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites", "title": "Create a check suite", "category": "checks", "subcategory": "suites", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "head_sha", "in": "body", "description": "The sha of the head commit.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response when the suite already exists
", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", "head_branch": "master", "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", "status": "completed", "conclusion": "neutral", "url": "https://api.github.com/repos/github/hello-world/check-suites/5", "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", "pull_requests": [], "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "app": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "delete_branch_on_merge": true, "subscribers_count": 42, "network_count": 0 }, "head_commit": { "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", "timestamp": "2016-10-10T00:00:00Z", "author": { "name": "The Octocat", "email": "octocat@nowhere.com" }, "committer": { "name": "The Octocat", "email": "octocat@nowhere.com" } }, "latest_check_runs_count": 1, "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" }, "schema": { "title": "CheckSuite", "description": "A suite of checks performed on the code of a given code change", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 5 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkNoZWNrU3VpdGU1" ] }, "head_branch": { "type": [ "string", "null" ], "examples": [ "master" ] }, "head_sha": { "description": "The SHA of the head commit that is being checked.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "status": { "type": [ "string", "null" ], "enum": [ "queued", "in_progress", "completed", null ], "examples": [ "completed" ] }, "conclusion": { "type": [ "string", "null" ], "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ], "examples": [ "neutral" ] }, "url": { "type": [ "string", "null" ], "examples": [ "https://api.github.com/repos/github/hello-world/check-suites/5" ] }, "before": { "type": [ "string", "null" ], "examples": [ "146e867f55c26428e5f9fade55a9bbf5e95a7912" ] }, "after": { "type": [ "string", "null" ], "examples": [ "d6fde92930d4715a2b49857d24b940956b26d2d3" ] }, "pull_requests": { "type": [ "array", "null" ], "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "head_commit": { "title": "Simple Commit", "description": "Simple Commit", "type": "object", "properties": { "id": { "type": "string" }, "tree_id": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "author": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "committer": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] } }, "required": [ "id", "tree_id", "message", "timestamp", "author", "committer" ] }, "latest_check_runs_count": { "type": "integer" }, "check_runs_url": { "type": "string" }, "rerequestable": { "type": "boolean" }, "runs_rerequestable": { "type": "boolean" } }, "required": [ "id", "node_id", "head_branch", "status", "conclusion", "head_sha", "url", "before", "after", "created_at", "updated_at", "app", "head_commit", "repository", "latest_check_runs_count", "check_runs_url", "pull_requests" ] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response when the suite was created
", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", "head_branch": "master", "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", "status": "completed", "conclusion": "neutral", "url": "https://api.github.com/repos/github/hello-world/check-suites/5", "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", "pull_requests": [], "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "app": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "delete_branch_on_merge": true, "subscribers_count": 42, "network_count": 0 }, "head_commit": { "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", "timestamp": "2016-10-10T00:00:00Z", "author": { "name": "The Octocat", "email": "octocat@nowhere.com" }, "committer": { "name": "The Octocat", "email": "octocat@nowhere.com" } }, "latest_check_runs_count": 1, "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" }, "schema": { "title": "CheckSuite", "description": "A suite of checks performed on the code of a given code change", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 5 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkNoZWNrU3VpdGU1" ] }, "head_branch": { "type": [ "string", "null" ], "examples": [ "master" ] }, "head_sha": { "description": "The SHA of the head commit that is being checked.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "status": { "type": [ "string", "null" ], "enum": [ "queued", "in_progress", "completed", null ], "examples": [ "completed" ] }, "conclusion": { "type": [ "string", "null" ], "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ], "examples": [ "neutral" ] }, "url": { "type": [ "string", "null" ], "examples": [ "https://api.github.com/repos/github/hello-world/check-suites/5" ] }, "before": { "type": [ "string", "null" ], "examples": [ "146e867f55c26428e5f9fade55a9bbf5e95a7912" ] }, "after": { "type": [ "string", "null" ], "examples": [ "d6fde92930d4715a2b49857d24b940956b26d2d3" ] }, "pull_requests": { "type": [ "array", "null" ], "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "head_commit": { "title": "Simple Commit", "description": "Simple Commit", "type": "object", "properties": { "id": { "type": "string" }, "tree_id": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "author": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "committer": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] } }, "required": [ "id", "tree_id", "message", "timestamp", "author", "committer" ] }, "latest_check_runs_count": { "type": "integer" }, "check_runs_url": { "type": "string" }, "rerequestable": { "type": "boolean" }, "runs_rerequestable": { "type": "boolean" } }, "required": [ "id", "node_id", "head_branch", "status", "conclusion", "head_sha", "url", "before", "after", "created_at", "updated_at", "app", "head_commit", "repository", "latest_check_runs_count", "check_runs_url", "pull_requests" ] } } } ], "previews": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\". Your GitHub App must have the checks:write permission to create check suites.
Response when the suite already exists
" }, { "httpStatusCode": "201", "description": "Response when the suite was created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", "title": "Update repository preferences for check suites", "category": "checks", "subcategory": "suites", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of objects", "name": "auto_trigger_checks", "in": "body", "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.
The id of the GitHub App.
Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.
Response
", "example": { "preferences": { "auto_trigger_checks": [ { "app_id": 2, "setting": true }, { "app_id": 4, "setting": false } ] }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 } } }, "schema": { "title": "Check Suite Preference", "description": "Check suite configuration preferences for a repository.", "type": "object", "required": [ "preferences", "repository" ], "properties": { "preferences": { "type": "object", "properties": { "auto_trigger_checks": { "type": "array", "items": { "type": "object", "properties": { "app_id": { "type": "integer" }, "setting": { "type": "boolean" } }, "required": [ "app_id", "setting" ] } } } }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } } ], "previews": [], "descriptionHTML": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", "title": "Get a check suite", "category": "checks", "subcategory": "suites", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "check_suite_id", "description": "The unique identifier of the check suite.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "check_suite_id": "CHECK_SUITE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", "head_branch": "master", "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", "status": "completed", "conclusion": "neutral", "url": "https://api.github.com/repos/github/hello-world/check-suites/5", "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", "pull_requests": [], "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "app": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "delete_branch_on_merge": true, "subscribers_count": 42, "network_count": 0 }, "head_commit": { "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", "timestamp": "2016-10-10T00:00:00Z", "author": { "name": "The Octocat", "email": "octocat@nowhere.com" }, "committer": { "name": "The Octocat", "email": "octocat@nowhere.com" } }, "latest_check_runs_count": 1, "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" }, "schema": { "title": "CheckSuite", "description": "A suite of checks performed on the code of a given code change", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 5 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkNoZWNrU3VpdGU1" ] }, "head_branch": { "type": [ "string", "null" ], "examples": [ "master" ] }, "head_sha": { "description": "The SHA of the head commit that is being checked.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "status": { "type": [ "string", "null" ], "enum": [ "queued", "in_progress", "completed", null ], "examples": [ "completed" ] }, "conclusion": { "type": [ "string", "null" ], "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ], "examples": [ "neutral" ] }, "url": { "type": [ "string", "null" ], "examples": [ "https://api.github.com/repos/github/hello-world/check-suites/5" ] }, "before": { "type": [ "string", "null" ], "examples": [ "146e867f55c26428e5f9fade55a9bbf5e95a7912" ] }, "after": { "type": [ "string", "null" ], "examples": [ "d6fde92930d4715a2b49857d24b940956b26d2d3" ] }, "pull_requests": { "type": [ "array", "null" ], "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "head_commit": { "title": "Simple Commit", "description": "Simple Commit", "type": "object", "properties": { "id": { "type": "string" }, "tree_id": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "author": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "committer": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] } }, "required": [ "id", "tree_id", "message", "timestamp", "author", "committer" ] }, "latest_check_runs_count": { "type": "integer" }, "check_runs_url": { "type": "string" }, "rerequestable": { "type": "boolean" }, "runs_rerequestable": { "type": "boolean" } }, "required": [ "id", "node_id", "head_branch", "status", "conclusion", "head_sha", "url", "before", "after", "created_at", "updated_at", "app", "head_commit", "repository", "latest_check_runs_count", "check_runs_url", "pull_requests" ] } } } ], "previews": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", "title": "Rerequest a check suite", "category": "checks", "subcategory": "suites", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "check_suite_id", "description": "The unique identifier of the check suite.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "check_suite_id": "CHECK_SUITE_ID" } }, "response": { "statusCode": "201", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.
To rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.
Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites", "title": "List check suites for a Git reference", "category": "checks", "subcategory": "suites", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ref", "description": "ref parameter
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true }, { "name": "app_id", "description": "Filters check suites by GitHub App id.
Returns check runs with the specified name.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "check_suites": [ { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", "head_branch": "master", "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", "status": "completed", "conclusion": "neutral", "url": "https://api.github.com/repos/github/hello-world/check-suites/5", "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", "pull_requests": [], "app": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "delete_branch_on_merge": true, "subscribers_count": 42, "network_count": 0 }, "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "head_commit": { "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", "timestamp": "2016-10-10T00:00:00Z", "author": { "name": "The Octocat", "email": "octocat@nowhere.com" }, "committer": { "name": "The Octocat", "email": "octocat@nowhere.com" } }, "latest_check_runs_count": 1, "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" } ] }, "schema": { "type": "object", "required": [ "total_count", "check_suites" ], "properties": { "total_count": { "type": "integer" }, "check_suites": { "type": "array", "items": { "title": "CheckSuite", "description": "A suite of checks performed on the code of a given code change", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 5 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkNoZWNrU3VpdGU1" ] }, "head_branch": { "type": [ "string", "null" ], "examples": [ "master" ] }, "head_sha": { "description": "The SHA of the head commit that is being checked.", "type": "string", "examples": [ "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "status": { "type": [ "string", "null" ], "enum": [ "queued", "in_progress", "completed", null ], "examples": [ "completed" ] }, "conclusion": { "type": [ "string", "null" ], "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ], "examples": [ "neutral" ] }, "url": { "type": [ "string", "null" ], "examples": [ "https://api.github.com/repos/github/hello-world/check-suites/5" ] }, "before": { "type": [ "string", "null" ], "examples": [ "146e867f55c26428e5f9fade55a9bbf5e95a7912" ] }, "after": { "type": [ "string", "null" ], "examples": [ "d6fde92930d4715a2b49857d24b940956b26d2d3" ] }, "pull_requests": { "type": [ "array", "null" ], "items": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "head_commit": { "title": "Simple Commit", "description": "Simple Commit", "type": "object", "properties": { "id": { "type": "string" }, "tree_id": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "author": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "committer": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] } }, "required": [ "id", "tree_id", "message", "timestamp", "author", "committer" ] }, "latest_check_runs_count": { "type": "integer" }, "check_runs_url": { "type": "string" }, "rerequestable": { "type": "boolean" }, "runs_rerequestable": { "type": "boolean" } }, "required": [ "id", "node_id", "head_branch", "status", "conclusion", "head_sha", "url", "before", "after", "created_at", "updated_at", "app", "head_commit", "repository", "latest_check_runs_count", "check_runs_url", "pull_requests" ] } } } } } } ], "previews": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
OK
" } ] } ] }, "code-scanning": { "code-scanning": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/code-scanning/alerts", "title": "List code scanning alerts for an enterprise", "category": "code-scanning", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tool_name", "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.
The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.
A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "direction", "description": "The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "state", "description": "If specified, only code scanning alerts with this state will be returned.
", "in": "query", "required": false, "schema": { "type": "string", "description": "State of a code scanning alert.", "enum": [ "open", "closed", "dismissed", "fixed" ] } }, { "name": "sort", "description": "The property by which to sort the results.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated" ], "default": "created" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "number": 4, "created_at": "2020-02-13T12:29:18Z", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", "html_url": "https://github.com/octocat/hello-world/code-scanning/4", "state": "open", "dismissed_by": null, "dismissed_at": null, "dismissed_reason": null, "dismissed_comment": null, "rule": { "id": "js/zipslip", "severity": "error", "tags": [ "security", "external/cwe/cwe-022" ], "description": "Arbitrary file write during zip extraction", "name": "js/zipslip" }, "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "most_recent_instance": { "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "{}", "state": "open", "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", "message": { "text": "This path depends on a user-provided value." }, "location": { "path": "spec-main/api-session-spec.ts", "start_line": 917, "end_line": 917, "start_column": 7, "end_column": 18 }, "classifications": [ "test" ] }, "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" } }, { "number": 3, "created_at": "2020-02-13T12:29:18Z", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", "html_url": "https://github.com/octocat/hello-world/code-scanning/3", "state": "dismissed", "dismissed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "dismissed_at": "2020-02-14T12:29:18Z", "dismissed_reason": "false positive", "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", "rule": { "id": "js/zipslip", "severity": "error", "tags": [ "security", "external/cwe/cwe-022" ], "description": "Arbitrary file write during zip extraction", "name": "js/zipslip" }, "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "most_recent_instance": { "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "{}", "state": "open", "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", "message": { "text": "This path depends on a user-provided value." }, "location": { "path": "lib/ab12-gen.js", "start_line": 917, "end_line": 917, "start_column": 7, "end_column": 18 }, "classifications": [] }, "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" } } ], "schema": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "created_at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true }, "html_url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", "readOnly": true }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", "format": "uri", "readOnly": true }, "state": { "type": "string", "description": "State of a code scanning alert.", "enum": [ "open", "closed", "dismissed", "fixed" ] }, "fixed_at": { "type": [ "string", "null" ], "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "dismissed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "dismissed_at": { "type": [ "string", "null" ], "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "dismissed_reason": { "type": [ "string", "null" ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ null, "false positive", "won't fix", "used in tests" ] }, "dismissed_comment": { "type": [ "string", "null" ], "description": "The dismissal comment associated with the dismissal of the alert.", "maxLength": 280 }, "rule": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "description": "A unique identifier for the rule used to detect the alert." }, "name": { "type": "string", "description": "The name of the rule used to detect the alert." }, "severity": { "type": [ "string", "null" ], "description": "The severity of the alert.", "enum": [ "none", "note", "warning", "error", null ] }, "security_severity_level": { "type": [ "string", "null" ], "description": "The security severity of the alert.", "enum": [ "low", "medium", "high", "critical", null ] }, "description": { "type": "string", "description": "A short description of the rule used to detect the alert." }, "full_description": { "type": "string", "description": "description of the rule used to detect the alert." }, "tags": { "type": [ "array", "null" ], "description": "A set of tags applicable for the rule.", "items": { "type": "string" } }, "help": { "type": [ "string", "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." }, "help_uri": { "type": [ "string", "null" ], "description": "A link to the documentation for the rule used to detect the alert." } } }, "tool": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tool used to generate the code scanning analysis." }, "version": { "type": [ "string", "null" ], "description": "The version of the tool used to generate the code scanning analysis." }, "guid": { "type": [ "string", "null" ], "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } } }, "most_recent_instance": { "type": "object", "properties": { "ref": { "type": "string", "description": "The full Git reference, formatted as `refs/heads/Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"
\nTo use this endpoint, you must be a member of the enterprise,\nand you must use an access token with the repo scope or security_events scope.
OK
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/code-scanning/alerts", "title": "List code scanning alerts for an organization", "category": "code-scanning", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tool_name", "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.
The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.
A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "direction", "description": "The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "state", "description": "If specified, only code scanning alerts with this state will be returned.
", "in": "query", "required": false, "schema": { "type": "string", "description": "State of a code scanning alert.", "enum": [ "open", "closed", "dismissed", "fixed" ] } }, { "name": "sort", "description": "The property by which to sort the results.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated" ], "default": "created" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "number": 4, "created_at": "2020-02-13T12:29:18Z", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", "html_url": "https://github.com/octocat/hello-world/code-scanning/4", "state": "open", "dismissed_by": null, "dismissed_at": null, "dismissed_reason": null, "dismissed_comment": null, "rule": { "id": "js/zipslip", "severity": "error", "tags": [ "security", "external/cwe/cwe-022" ], "description": "Arbitrary file write during zip extraction", "name": "js/zipslip" }, "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "most_recent_instance": { "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "{}", "state": "open", "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", "message": { "text": "This path depends on a user-provided value." }, "location": { "path": "spec-main/api-session-spec.ts", "start_line": 917, "end_line": 917, "start_column": 7, "end_column": 18 }, "classifications": [ "test" ] }, "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" } }, { "number": 3, "created_at": "2020-02-13T12:29:18Z", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", "html_url": "https://github.com/octocat/hello-world/code-scanning/3", "state": "dismissed", "dismissed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "dismissed_at": "2020-02-14T12:29:18Z", "dismissed_reason": "false positive", "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", "rule": { "id": "js/zipslip", "severity": "error", "tags": [ "security", "external/cwe/cwe-022" ], "description": "Arbitrary file write during zip extraction", "name": "js/zipslip" }, "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "most_recent_instance": { "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "{}", "state": "open", "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", "message": { "text": "This path depends on a user-provided value." }, "location": { "path": "lib/ab12-gen.js", "start_line": 917, "end_line": 917, "start_column": 7, "end_column": 18 }, "classifications": [] }, "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" } } ], "schema": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "created_at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true }, "html_url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", "readOnly": true }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", "format": "uri", "readOnly": true }, "state": { "type": "string", "description": "State of a code scanning alert.", "enum": [ "open", "closed", "dismissed", "fixed" ] }, "fixed_at": { "type": [ "string", "null" ], "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "dismissed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "dismissed_at": { "type": [ "string", "null" ], "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "dismissed_reason": { "type": [ "string", "null" ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ null, "false positive", "won't fix", "used in tests" ] }, "dismissed_comment": { "type": [ "string", "null" ], "description": "The dismissal comment associated with the dismissal of the alert.", "maxLength": 280 }, "rule": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "description": "A unique identifier for the rule used to detect the alert." }, "name": { "type": "string", "description": "The name of the rule used to detect the alert." }, "severity": { "type": [ "string", "null" ], "description": "The severity of the alert.", "enum": [ "none", "note", "warning", "error", null ] }, "security_severity_level": { "type": [ "string", "null" ], "description": "The security severity of the alert.", "enum": [ "low", "medium", "high", "critical", null ] }, "description": { "type": "string", "description": "A short description of the rule used to detect the alert." }, "full_description": { "type": "string", "description": "description of the rule used to detect the alert." }, "tags": { "type": [ "array", "null" ], "description": "A set of tags applicable for the rule.", "items": { "type": "string" } }, "help": { "type": [ "string", "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." }, "help_uri": { "type": [ "string", "null" ], "description": "A link to the documentation for the rule used to detect the alert." } } }, "tool": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tool used to generate the code scanning analysis." }, "version": { "type": [ "string", "null" ], "description": "The version of the tool used to generate the code scanning analysis." }, "guid": { "type": [ "string", "null" ], "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } } }, "most_recent_instance": { "type": "object", "properties": { "ref": { "type": "string", "description": "The full Git reference, formatted as `refs/heads/Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"
\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the repo scope or security_events scope.
For public repositories, you may instead use the public_repo scope.
GitHub Apps must have the security_events read permission to use this endpoint.
OK
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts", "title": "List code scanning alerts for a repository", "category": "code-scanning", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tool_name", "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.
The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.
Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "ref", "description": "The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "sort", "description": "The property by which to sort the results.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated" ], "default": "created" } }, { "name": "state", "description": "If specified, only code scanning alerts with this state will be returned.
", "in": "query", "required": false, "schema": { "type": "string", "description": "State of a code scanning alert.", "enum": [ "open", "closed", "dismissed", "fixed" ] } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "number": 4, "created_at": "2020-02-13T12:29:18Z", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", "html_url": "https://github.com/octocat/hello-world/code-scanning/4", "state": "open", "fixed_at": null, "dismissed_by": null, "dismissed_at": null, "dismissed_reason": null, "dismissed_comment": null, "rule": { "id": "js/zipslip", "severity": "error", "tags": [ "security", "external/cwe/cwe-022" ], "description": "Arbitrary file write during zip extraction", "name": "js/zipslip" }, "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "most_recent_instance": { "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "{}", "state": "open", "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", "message": { "text": "This path depends on a user-provided value." }, "location": { "path": "spec-main/api-session-spec.ts", "start_line": 917, "end_line": 917, "start_column": 7, "end_column": 18 }, "classifications": [ "test" ] }, "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances" }, { "number": 3, "created_at": "2020-02-13T12:29:18Z", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", "html_url": "https://github.com/octocat/hello-world/code-scanning/3", "state": "dismissed", "fixed_at": null, "dismissed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "dismissed_at": "2020-02-14T12:29:18Z", "dismissed_reason": "false positive", "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", "rule": { "id": "js/zipslip", "severity": "error", "tags": [ "security", "external/cwe/cwe-022" ], "description": "Arbitrary file write during zip extraction", "name": "js/zipslip" }, "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "most_recent_instance": { "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "{}", "state": "open", "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", "message": { "text": "This path depends on a user-provided value." }, "location": { "path": "lib/ab12-gen.js", "start_line": 917, "end_line": 917, "start_column": 7, "end_column": 18 }, "classifications": [] }, "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances" } ], "schema": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "created_at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true }, "html_url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", "readOnly": true }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", "format": "uri", "readOnly": true }, "state": { "type": "string", "description": "State of a code scanning alert.", "enum": [ "open", "closed", "dismissed", "fixed" ] }, "fixed_at": { "type": [ "string", "null" ], "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "dismissed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "dismissed_at": { "type": [ "string", "null" ], "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "dismissed_reason": { "type": [ "string", "null" ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ null, "false positive", "won't fix", "used in tests" ] }, "dismissed_comment": { "type": [ "string", "null" ], "description": "The dismissal comment associated with the dismissal of the alert.", "maxLength": 280 }, "rule": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "description": "A unique identifier for the rule used to detect the alert." }, "name": { "type": "string", "description": "The name of the rule used to detect the alert." }, "tags": { "type": [ "array", "null" ], "description": "A set of tags applicable for the rule.", "items": { "type": "string" } }, "severity": { "type": [ "string", "null" ], "description": "The severity of the alert.", "enum": [ "none", "note", "warning", "error", null ] }, "description": { "type": "string", "description": "A short description of the rule used to detect the alert." } } }, "tool": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tool used to generate the code scanning analysis." }, "version": { "type": [ "string", "null" ], "description": "The version of the tool used to generate the code scanning analysis." }, "guid": { "type": [ "string", "null" ], "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } } }, "most_recent_instance": { "type": "object", "properties": { "ref": { "type": "string", "description": "The full Git reference, formatted as `refs/heads/Lists code scanning alerts.
\nTo use this endpoint, you must use an access token with the security_events scope or, for alerts from public repositories only, an access token with the public_repo scope.
GitHub Apps must have the security_events read\npermission to use this endpoint.
The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used ref in the request).
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "title": "Get a code scanning alert", "category": "code-scanning", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alert_number", "in": "path", "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Response
", "example": { "number": 42, "created_at": "2020-06-19T11:21:34Z", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", "html_url": "https://github.com/octocat/hello-world/code-scanning/42", "state": "dismissed", "fixed_at": null, "dismissed_by": { "login": "octocat", "id": 54933897, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "dismissed_at": "2020-02-14T12:29:18Z", "dismissed_reason": "false positive", "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", "rule": { "id": "js/zipslip", "severity": "error", "security_severity_level": "high", "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", "name": "js/zipslip", "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", "tags": [ "security", "external/cwe/cwe-022" ], "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "most_recent_instance": { "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "{}", "state": "dismissed", "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", "message": { "text": "This path depends on a user-provided value." }, "location": { "path": "spec-main/api-session-spec.ts", "start_line": 917, "end_line": 917, "start_column": 7, "end_column": 18 }, "classifications": [ "test" ] }, "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" }, "schema": { "type": "object", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "created_at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true }, "html_url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", "readOnly": true }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", "format": "uri", "readOnly": true }, "state": { "type": "string", "description": "State of a code scanning alert.", "enum": [ "open", "closed", "dismissed", "fixed" ] }, "fixed_at": { "type": [ "string", "null" ], "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "dismissed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "dismissed_at": { "type": [ "string", "null" ], "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "dismissed_reason": { "type": [ "string", "null" ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ null, "false positive", "won't fix", "used in tests" ] }, "dismissed_comment": { "type": [ "string", "null" ], "description": "The dismissal comment associated with the dismissal of the alert.", "maxLength": 280 }, "rule": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "description": "A unique identifier for the rule used to detect the alert." }, "name": { "type": "string", "description": "The name of the rule used to detect the alert." }, "severity": { "type": [ "string", "null" ], "description": "The severity of the alert.", "enum": [ "none", "note", "warning", "error", null ] }, "security_severity_level": { "type": [ "string", "null" ], "description": "The security severity of the alert.", "enum": [ "low", "medium", "high", "critical", null ] }, "description": { "type": "string", "description": "A short description of the rule used to detect the alert." }, "full_description": { "type": "string", "description": "description of the rule used to detect the alert." }, "tags": { "type": [ "array", "null" ], "description": "A set of tags applicable for the rule.", "items": { "type": "string" } }, "help": { "type": [ "string", "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." }, "help_uri": { "type": [ "string", "null" ], "description": "A link to the documentation for the rule used to detect the alert." } } }, "tool": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tool used to generate the code scanning analysis." }, "version": { "type": [ "string", "null" ], "description": "The version of the tool used to generate the code scanning analysis." }, "guid": { "type": [ "string", "null" ], "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } } }, "most_recent_instance": { "type": "object", "properties": { "ref": { "type": "string", "description": "The full Git reference, formatted as `refs/heads/Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.
Deprecation notice:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by instances_url.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "title": "Update a code scanning alert", "category": "code-scanning", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alert_number", "in": "path", "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.
Required when the state is dismissed. The reason for dismissing or closing the alert.
", "enum": [ null, "false positive", "won't fix", "used in tests" ] }, { "type": "string or null", "name": "dismissed_comment", "in": "body", "description": "The dismissal comment associated with the dismissal of the alert.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", "dismissed_reason": "false positive", "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library." }, "parameters": { "owner": "OWNER", "repo": "REPO", "alert_number": "ALERT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "number": 42, "created_at": "2020-08-25T21:28:36Z", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", "html_url": "https://github.com/octocat/hello-world/code-scanning/42", "state": "dismissed", "fixed_at": null, "dismissed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "dismissed_at": "2020-09-02T22:34:56Z", "dismissed_reason": "false positive", "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", "rule": { "id": "js/zipslip", "severity": "error", "security_severity_level": "high", "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", "name": "js/zipslip", "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", "tags": [ "security", "external/cwe/cwe-022" ], "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "most_recent_instance": { "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "{}", "state": "dismissed", "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", "message": { "text": "This path depends on a user-provided value." }, "location": { "path": "spec-main/api-session-spec.ts", "start_line": 917, "end_line": 917, "start_column": 7, "end_column": 18 }, "classifications": [ "test" ] }, "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" }, "schema": { "type": "object", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "created_at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true }, "html_url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", "readOnly": true }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", "format": "uri", "readOnly": true }, "state": { "type": "string", "description": "State of a code scanning alert.", "enum": [ "open", "closed", "dismissed", "fixed" ] }, "fixed_at": { "type": [ "string", "null" ], "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "dismissed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "dismissed_at": { "type": [ "string", "null" ], "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "dismissed_reason": { "type": [ "string", "null" ], "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "enum": [ null, "false positive", "won't fix", "used in tests" ] }, "dismissed_comment": { "type": [ "string", "null" ], "description": "The dismissal comment associated with the dismissal of the alert.", "maxLength": 280 }, "rule": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "description": "A unique identifier for the rule used to detect the alert." }, "name": { "type": "string", "description": "The name of the rule used to detect the alert." }, "severity": { "type": [ "string", "null" ], "description": "The severity of the alert.", "enum": [ "none", "note", "warning", "error", null ] }, "security_severity_level": { "type": [ "string", "null" ], "description": "The security severity of the alert.", "enum": [ "low", "medium", "high", "critical", null ] }, "description": { "type": "string", "description": "A short description of the rule used to detect the alert." }, "full_description": { "type": "string", "description": "description of the rule used to detect the alert." }, "tags": { "type": [ "array", "null" ], "description": "A set of tags applicable for the rule.", "items": { "type": "string" } }, "help": { "type": [ "string", "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." }, "help_uri": { "type": [ "string", "null" ], "description": "A link to the documentation for the rule used to detect the alert." } } }, "tool": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tool used to generate the code scanning analysis." }, "version": { "type": [ "string", "null" ], "description": "The version of the tool used to generate the code scanning analysis." }, "guid": { "type": [ "string", "null" ], "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } } }, "most_recent_instance": { "type": "object", "properties": { "ref": { "type": "string", "description": "The full Git reference, formatted as `refs/heads/Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.
OK
" }, { "httpStatusCode": "403", "description": "Response if the repository is archived or if github advanced security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", "title": "List instances of a code scanning alert", "category": "code-scanning", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alert_number", "in": "path", "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "ref", "description": "The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
Response
", "example": [ { "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", "message": { "text": "This path depends on a user-provided value." }, "location": { "path": "lib/ab12-gen.js", "start_line": 917, "end_line": 917, "start_column": 7, "end_column": 18 }, "classifications": [ "library" ] }, { "ref": "refs/pull/3740/merge", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "fixed", "fixed_at": "2020-02-14T12:29:18Z", "commit_sha": "b09da05606e27f463a2b49287684b4ae777092f2", "message": { "text": "This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1." }, "location": { "path": "app/script.js", "start_line": 2, "end_line": 2, "start_column": 10, "end_column": 50 }, "classifications": [ "source" ] } ], "schema": { "type": "array", "items": { "type": "object", "properties": { "ref": { "type": "string", "description": "The full Git reference, formatted as `refs/heads/Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.\nGitHub Apps must have the security_events read permission to use this endpoint.
OK
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses", "title": "List code scanning analyses for a repository", "category": "code-scanning", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tool_name", "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.
The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.
Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "ref", "in": "query", "description": "The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
Filter analyses belonging to the same SARIF upload.
", "required": false, "schema": { "type": "string", "description": "An identifier for the upload.", "examples": [ "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" ] } }, { "name": "direction", "description": "The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "sort", "description": "The property by which to sort the results.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created" ], "default": "created" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "ref": "refs/heads/main", "commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83", "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, "id": 201, "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", "sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "deletable": true, "warning": "" }, { "ref": "refs/heads/my-branch", "commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321", "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, "id": 200, "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200", "sarif_id": "8981cd8e-b078-4ac3-a3be-1dad7dbd0b582", "tool": { "name": "Python Security Analysis", "guid": null, "version": "1.2.0" }, "deletable": true, "warning": "" } ], "schema": { "type": "array", "items": { "type": "object", "properties": { "ref": { "type": "string", "description": "The full Git reference, formatted as `refs/heads/Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
You must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.\nGitHub Apps must have the security_events read permission to use this endpoint.
Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OK
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", "title": "Get a code scanning analysis for a repository", "category": "code-scanning", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "analysis_id", "in": "path", "description": "The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation.
application/json response
", "example": { "ref": "refs/heads/main", "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"javascript\"}", "error": "", "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", "created_at": "2021-01-13T11:55:49Z", "results_count": 3, "rules_count": 67, "id": 3602840, "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", "sarif_id": "47177e22-5596-11eb-80a1-c1e54ef945c6", "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "deletable": true, "warning": "" }, "schema": { "type": "object", "properties": { "ref": { "type": "string", "description": "The full Git reference, formatted as `refs/heads/application/json+sarif response
", "example": { "runs": [ { "tool": { "driver": { "name": "CodeQL", "organization": "GitHub", "semanticVersion": "1.0.0", "rules": [ { "id": "js/unused-local-variable", "name": "js/unused-local-variable" } ] } }, "results": [ { "guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38", "message": { "text": "Unused variable foo." }, "locations": [ { "physicalLocation": { "artifactLocation": { "uri": "file1.js" }, "region": { "startLine": 1 } } } ], "ruleId": "js/unused-local-variable", "properties": [ { "github/alertNumber": 2 }, { "github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2" } ] } ] } ] }, "schema": { "type": "object", "additionalProperties": true } } } ], "previews": [], "descriptionHTML": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.\nGitHub Apps must have the security_events read permission to use this endpoint.
The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.
\nThe rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.
OK
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", "title": "Delete a code scanning analysis from a repository", "category": "code-scanning", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "analysis_id", "in": "path", "description": "The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation.
Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to true, you'll get a 400 response with the message: Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.
Default response
", "example": { "next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41", "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete" }, "schema": { "title": "Analysis deletion", "description": "Successful deletion of a code scanning analysis", "type": "object", "properties": { "next_analysis_url": { "type": [ "string", "null" ], "description": "Next deletable analysis in chain, without last analysis deletion confirmation", "format": "uri", "readOnly": true }, "confirm_delete_url": { "type": [ "string", "null" ], "description": "Next deletable analysis in chain, with last analysis deletion confirmation", "format": "uri", "readOnly": true } }, "required": [ "next_analysis_url", "confirm_delete_url" ] } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "403", "description": "Response if the repository is archived or if github advanced security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "descriptionHTML": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.
You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.
\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:
\n\"deletable\": true\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:
\n- \n
ref\ntool\ncategory\n
If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:
\nAnalysis specified is not deletable.\nThe response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.
As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:
\nOuter loop:
\n- \n
- \n
List the analyses for the repository, filtered by tool.
\n \n - \n
Parse this list to find a deletable analysis. If found:
\nInner loop:
\n- \n
- Delete the identified analysis. \n
- Parse the response for the value of
confirm_delete_urland, if found, use this in the next iteration. \n
\n
The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.
The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "commit_sha", "in": "body", "description": "The SHA of the commit to which the analysis you are uploading relates.
", "isRequired": true }, { "type": "string", "name": "ref", "in": "body", "description": "The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.
A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"
The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.
" }, { "type": "string", "name": "started_at", "in": "body", "description": "The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.
Default response
", "example": { "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" }, "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An identifier for the upload.", "examples": [ "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" ] }, "url": { "type": "string", "description": "The REST API URL for checking the status of the upload.", "format": "uri", "readOnly": true } } } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "400", "description": "Bad Request if the sarif field is invalid
" }, { "httpStatusCode": "403", "description": "Response if the repository is archived or if github advanced security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "413", "description": "Payload Too Large if the sarif field is too large
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "descriptionHTML": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.
There are two places where you can upload code scanning results.
\n- \n
- If you upload to a pull request, for example
--ref refs/pull/42/mergeor--ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\" \n - If you upload to a branch, for example
--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\" \n
You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.
\nThe 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sarif_id", "description": "The SARIF ID obtained after uploading.
", "in": "path", "schema": { "type": "string" }, "required": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "sarif_id": "SARIF_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Default response
", "example": { "processing_status": "complete", "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" }, "schema": { "type": "object", "properties": { "processing_status": { "type": "string", "enum": [ "pending", "complete", "failed" ], "description": "`pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed." }, "analyses_url": { "type": [ "string", "null" ], "description": "The REST API URL for getting the analyses associated with the upload.", "format": "uri", "readOnly": true }, "errors": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Any errors that ocurred during processing of the delivery.", "readOnly": true } } } } } ], "previews": [], "descriptionHTML": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.
OK
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Not Found if the sarif id does not match any upload
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" } ] }, "codes-of-conduct": { "codes-of-conduct": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/codes_of_conduct", "title": "Get all codes of conduct", "category": "codes-of-conduct", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "key": "citizen_code_of_conduct", "name": "Citizen Code of Conduct", "url": "https://api.github.com/codes_of_conduct/citizen_code_of_conduct", "html_url": "http://citizencodeofconduct.org/" }, { "key": "contributor_covenant", "name": "Contributor Covenant", "url": "https://api.github.com/codes_of_conduct/contributor_covenant", "html_url": "https://www.contributor-covenant.org/version/2/0/code_of_conduct/" } ], "schema": { "type": "array", "items": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "codes-of-conduct" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/codes_of_conduct/{key}", "title": "Get a code of conduct", "category": "codes-of-conduct", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key": "KEY" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key": "contributor_covenant", "name": "Contributor Covenant", "url": "https://api.github.com/codes_of_conduct/contributor_covenant", "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n", "html_url": "http://contributor-covenant.org/version/1/4/" }, "schema": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "codes-of-conduct" } ] }, "codespaces": { "codespaces": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codespaces", "title": "List codespaces in a repository for the authenticated user", "category": "codespaces", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "codespaces": [ { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "recent_folders": [] }, { "id": 2, "name": "monalisa-octocat-hello-world-3f89ada1j3", "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", "recent_folders": [] } ] }, "schema": { "type": "object", "required": [ "total_count", "codespaces" ], "properties": { "total_count": { "type": "integer" }, "codespaces": { "type": "array", "items": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists the codespaces associated to a specified repository and the authenticated user.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have read access to the codespaces repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/codespaces", "title": "Create a codespace in a repository", "category": "codespaces", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "ref", "in": "body", "description": "Git ref (typically a branch name) for this codespace
" }, { "type": "string", "name": "location", "in": "body", "description": "Location for this codespace. Assigned by IP if not provided
" }, { "type": "string", "name": "client_ip", "in": "body", "description": "IP for location auto-detection when proxying a request
" }, { "type": "string", "name": "machine", "in": "body", "description": "Machine type to use for this codespace
" }, { "type": "string", "name": "devcontainer_path", "in": "body", "description": "Path to devcontainer.json config to use for this codespace
" }, { "type": "boolean", "name": "multi_repo_permissions_opt_out", "in": "body", "description": "Whether to authorize requested permissions from devcontainer.json
" }, { "type": "string", "name": "working_directory", "in": "body", "description": "Working directory for this codespace
" }, { "type": "integer", "name": "idle_timeout_minutes", "in": "body", "description": "Time in minutes before codespace stops from inactivity
" }, { "type": "string", "name": "display_name", "in": "body", "description": "Display name for this codespace
" }, { "type": "integer", "name": "retention_period_minutes", "in": "body", "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).
" } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "main", "machine": "standardLinux32gb" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response when the codespace was successfully created
", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "retention_period_minutes": 43200, "retention_expires_at": null, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [], "template": null }, "schema": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example 2: Status Code 202", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "main", "machine": "standardLinux32gb" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response when the codespace creation partially failed but is being retried in the background
", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "retention_period_minutes": 43200, "retention_expires_at": null, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [], "template": null }, "schema": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } } ], "previews": [], "descriptionHTML": "Creates a codespace owned by the authenticated user in the specified repository.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces repository permission to use this endpoint.
Response when the codespace was successfully created
" }, { "httpStatusCode": "202", "description": "Response when the codespace creation partially failed but is being retried in the background
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codespaces/devcontainers", "title": "List devcontainer configurations in a repository for the authenticated user", "category": "codespaces", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "devcontainers": [ { "path": ".devcontainer/foobar/devcontainer.json", "name": "foobar" }, { "path": ".devcontainer/devcontainer.json", "name": "kitchensink" }, { "path": ".devcontainer.json" } ], "total_count": 3 }, "schema": { "type": "object", "required": [ "total_count", "devcontainers" ], "properties": { "total_count": { "type": "integer" }, "devcontainers": { "type": "array", "items": { "type": "object", "required": [ "path" ], "properties": { "path": { "type": "string" }, "name": { "type": "string" } } } } } } } } ], "previews": [], "descriptionHTML": "Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files\nspecify launchpoint configurations for codespaces created within the repository.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have read access to the codespaces_metadata repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codespaces/new", "title": "Get default attributes for a codespace", "category": "codespaces", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ref", "description": "The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked.
", "in": "query", "schema": { "type": "string", "examples": [ "main" ] } }, { "name": "client_ip", "description": "An alternative IP for default location auto-detection, such as when proxying a request.
", "in": "query", "schema": { "type": "string", "examples": [ "1.2.3.4" ] } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response when a user is able to create codespaces from the repository.
", "example": { "devcontainers": [ { "path": ".devcontainer/foobar/devcontainer.json", "name": "foobar" }, { "path": ".devcontainer/devcontainer.json", "name": "kitchensink" }, { "path": ".devcontainer.json" } ], "total_count": 3 }, "schema": { "type": "object", "properties": { "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "defaults": { "type": "object", "required": [ "location", "devcontainer_path" ], "properties": { "location": { "type": "string" }, "devcontainer_path": { "type": [ "string", "null" ] } } } } } } } ], "previews": [], "descriptionHTML": "Gets the default attributes for codespaces created by the user with the repository.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces repository permission to use this endpoint.
Response when a user is able to create codespaces from the repository.
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces", "title": "Create a codespace from a pull request", "category": "codespaces", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "location", "in": "body", "description": "Location for this codespace. Assigned by IP if not provided
" }, { "type": "string", "name": "client_ip", "in": "body", "description": "IP for location auto-detection when proxying a request
" }, { "type": "string", "name": "machine", "in": "body", "description": "Machine type to use for this codespace
" }, { "type": "string", "name": "devcontainer_path", "in": "body", "description": "Path to devcontainer.json config to use for this codespace
" }, { "type": "boolean", "name": "multi_repo_permissions_opt_out", "in": "body", "description": "Whether to authorize requested permissions from devcontainer.json
" }, { "type": "string", "name": "working_directory", "in": "body", "description": "Working directory for this codespace
" }, { "type": "integer", "name": "idle_timeout_minutes", "in": "body", "description": "Time in minutes before codespace stops from inactivity
" }, { "type": "string", "name": "display_name", "in": "body", "description": "Display name for this codespace
" }, { "type": "integer", "name": "retention_period_minutes", "in": "body", "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).
" } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, "ref": "main" }, "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response when the codespace was successfully created
", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "retention_period_minutes": 43200, "retention_expires_at": null, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [], "template": null }, "schema": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example 2: Status Code 202", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, "ref": "main" }, "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response when the codespace creation partially failed but is being retried in the background
", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "retention_period_minutes": 43200, "retention_expires_at": null, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [], "template": null }, "schema": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } } ], "previews": [], "descriptionHTML": "Creates a codespace owned by the authenticated user for the specified pull request.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces repository permission to use this endpoint.
Response when the codespace was successfully created
" }, { "httpStatusCode": "202", "description": "Response when the codespace creation partially failed but is being retried in the background
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces", "title": "List codespaces for the authenticated user", "category": "codespaces", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "repository_id", "description": "ID of the Repository to filter on
", "in": "query", "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 3, "codespaces": [ { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "recent_folders": [] }, { "id": 1, "name": "monalisa-octocat-hello-world-3f89ada1j3", "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/foobar/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", "recent_folders": [] }, { "id": 1, "name": "monalisa-octocat-hello-world-f8adfad99a", "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", "recent_folders": [] } ] }, "schema": { "type": "object", "required": [ "total_count", "codespaces" ], "properties": { "total_count": { "type": "integer" }, "codespaces": { "type": "array", "items": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists the authenticated user's codespaces.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have read access to the codespaces repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/codespaces", "title": "Create a codespace for the authenticated user", "category": "codespaces", "parameters": [], "bodyParameters": [ { "type": "integer", "name": "repository_id", "in": "body", "description": "Repository id for this codespace
", "isRequired": true }, { "type": "string", "name": "ref", "in": "body", "description": "Git ref (typically a branch name) for this codespace
" }, { "type": "string", "name": "location", "in": "body", "description": "Location for this codespace. Assigned by IP if not provided
" }, { "type": "string", "name": "client_ip", "in": "body", "description": "IP for location auto-detection when proxying a request
" }, { "type": "string", "name": "machine", "in": "body", "description": "Machine type to use for this codespace
" }, { "type": "string", "name": "devcontainer_path", "in": "body", "description": "Path to devcontainer.json config to use for this codespace
" }, { "type": "boolean", "name": "multi_repo_permissions_opt_out", "in": "body", "description": "Whether to authorize requested permissions from devcontainer.json
" }, { "type": "string", "name": "working_directory", "in": "body", "description": "Working directory for this codespace
" }, { "type": "integer", "name": "idle_timeout_minutes", "in": "body", "description": "Time in minutes before codespace stops from inactivity
" }, { "type": "string", "name": "display_name", "in": "body", "description": "Display name for this codespace
" }, { "type": "integer", "name": "retention_period_minutes", "in": "body", "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).
" }, { "type": "object", "name": "pull_request", "in": "body", "description": "Pull request number for this codespace
", "isRequired": true, "childParamsGroups": [ { "type": "integer", "name": "pull_request_number", "description": "Pull request number
", "isRequired": true }, { "type": "integer", "name": "repository_id", "description": "Repository id for this codespace
", "isRequired": true } ] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, "ref": "main", "location": "WestUs2" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response when the codespace was successfully created
", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "retention_period_minutes": 43200, "retention_expires_at": null, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [], "template": null }, "schema": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example 2: Status Code 202", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, "ref": "main", "location": "WestUs2" } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response when the codespace creation partially failed but is being retried in the background
", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "retention_period_minutes": 43200, "retention_expires_at": null, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [], "template": null }, "schema": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } } ], "previews": [], "descriptionHTML": "Creates a new codespace, owned by the authenticated user.
\nThis endpoint requires either a repository_id OR a pull_request but not both.
You must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces repository permission to use this endpoint.
Response when the codespace was successfully created
" }, { "httpStatusCode": "202", "description": "Response when the codespace creation partially failed but is being retried in the background
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/{codespace_name}", "title": "Get a codespace for the authenticated user", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "description": "The name of the codespace.
", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "retention_period_minutes": 43200, "retention_expires_at": null, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [], "template": null }, "schema": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } } ], "previews": [], "descriptionHTML": "Gets information about a user's codespace.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have read access to the codespaces repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/user/codespaces/{codespace_name}", "title": "Update a codespace for the authenticated user", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "description": "The name of the codespace.
", "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "machine", "in": "body", "description": "A valid machine to transition this codespace to.
" }, { "type": "string", "name": "display_name", "in": "body", "description": "Display name for this codespace
" }, { "type": "array of strings", "name": "recent_folders", "in": "body", "description": "Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.
" } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "machine": "standardLinux" }, "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "retention_period_minutes": 43200, "retention_expires_at": null, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [], "template": null }, "schema": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } } ], "previews": [], "descriptionHTML": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.
\nIf you specify a new machine type it will be applied the next time your codespace is started.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/codespaces/{codespace_name}", "title": "Delete a codespace for the authenticated user", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "description": "The name of the codespace.
", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "202", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "202", "description": "Accepted
" } } ], "previews": [], "descriptionHTML": "Deletes a user's codespace.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces repository permission to use this endpoint.
Accepted
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/codespaces/{codespace_name}/exports", "title": "Export a codespace for the authenticated user", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "description": "The name of the codespace.
", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response
", "example": { "state": "succeeded", "completed_at": "2022-01-01T14:59:22Z", "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q", "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2", "id": "latest", "export_url": "https://api.github.com/user/codespaces/:name/exports/latest" }, "schema": { "type": "object", "title": "Fetches information about an export of a codespace.", "description": "An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest", "properties": { "state": { "type": [ "string", "null" ], "description": "State of the latest export", "examples": [ "succeeded | failed | in_progress" ] }, "completed_at": { "description": "Completion time of the last export operation", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2021-01-01T19:01:12Z" ] }, "branch": { "type": [ "string", "null" ], "description": "Name of the exported branch", "examples": [ "codespace-monalisa-octocat-hello-world-g4wpq6h95q" ] }, "sha": { "type": [ "string", "null" ], "description": "Git commit SHA of the exported branch", "examples": [ "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2" ] }, "id": { "type": "string", "description": "Id for the export details", "examples": [ "latest" ] }, "export_url": { "type": "string", "description": "Url for fetching export details", "examples": [ "https://api.github.com/user/codespaces/:name/exports/latest" ] }, "html_url": { "type": [ "string", "null" ], "description": "Web url for the exported branch", "examples": [ "https://github.com/octocat/hello-world/tree/:branch" ] } } } } } ], "previews": [], "descriptionHTML": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.
\nYou must authenticate using a personal access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces_lifecycle_admin repository permission to use this endpoint.
Accepted
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/{codespace_name}/exports/{export_id}", "title": "Get details about a codespace export", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "description": "The name of the codespace.
", "schema": { "type": "string" } }, { "name": "export_id", "in": "path", "required": true, "description": "The ID of the export operation, or latest. Currently only latest is currently supported.
Response
", "example": { "state": "succeeded", "completed_at": "2022-01-01T14:59:22Z", "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q", "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2", "id": "latest", "export_url": "https://api.github.com/user/codespaces/:name/exports/latest" }, "schema": { "type": "object", "title": "Fetches information about an export of a codespace.", "description": "An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest", "properties": { "state": { "type": [ "string", "null" ], "description": "State of the latest export", "examples": [ "succeeded | failed | in_progress" ] }, "completed_at": { "description": "Completion time of the last export operation", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2021-01-01T19:01:12Z" ] }, "branch": { "type": [ "string", "null" ], "description": "Name of the exported branch", "examples": [ "codespace-monalisa-octocat-hello-world-g4wpq6h95q" ] }, "sha": { "type": [ "string", "null" ], "description": "Git commit SHA of the exported branch", "examples": [ "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2" ] }, "id": { "type": "string", "description": "Id for the export details", "examples": [ "latest" ] }, "export_url": { "type": "string", "description": "Url for fetching export details", "examples": [ "https://api.github.com/user/codespaces/:name/exports/latest" ] }, "html_url": { "type": [ "string", "null" ], "description": "Web url for the exported branch", "examples": [ "https://github.com/octocat/hello-world/tree/:branch" ] } } } } } ], "previews": [], "descriptionHTML": "Gets information about an export of a codespace.
\nYou must authenticate using a personal access token with the codespace scope to use this endpoint.
GitHub Apps must have read access to the codespaces_lifecycle_admin repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/codespaces/{codespace_name}/start", "title": "Start a codespace for the authenticated user", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "description": "The name of the codespace.
", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "retention_period_minutes": 43200, "retention_expires_at": null, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [], "template": null }, "schema": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } } ], "previews": [], "descriptionHTML": "Starts a user's codespace.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces_lifecycle_admin repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "402", "description": "Payment required
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/codespaces/{codespace_name}/stop", "title": "Stop a codespace for the authenticated user", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "description": "The name of the codespace.
", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "retention_period_minutes": 43200, "retention_expires_at": null, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [], "template": null }, "schema": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } } ], "previews": [], "descriptionHTML": "Stops a user's codespace.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces_lifecycle_admin repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" } ], "machines": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codespaces/machines", "title": "List available machine types for a repository", "category": "codespaces", "subcategory": "machines", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "location", "description": "The location to check for available machines. Assigned by IP if not provided.
", "in": "query", "schema": { "type": "string", "examples": [ "WestUs2" ] } }, { "name": "client_ip", "description": "IP for location auto-detection when proxying a request
", "in": "query", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "machines": [ { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, { "name": "premiumLinux", "display_name": "8 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 8 } ] }, "schema": { "type": "object", "required": [ "total_count", "machines" ], "properties": { "total_count": { "type": "integer" }, "machines": { "type": "array", "items": { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } } } } } } ], "previews": [], "descriptionHTML": "List the machine types available for a given repository based on its configuration.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces_metadata repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/{codespace_name}/machines", "title": "List machine types for a codespace", "category": "codespaces", "subcategory": "machines", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "description": "The name of the codespace.
", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "machines": [ { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, { "name": "premiumLinux", "display_name": "8 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 8 } ] }, "schema": { "type": "object", "required": [ "total_count", "machines" ], "properties": { "total_count": { "type": "integer" }, "machines": { "type": "array", "items": { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } } } } } } ], "previews": [], "descriptionHTML": "List the machine types a codespace can transition to use.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have read access to the codespaces_metadata repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] } ], "organizations": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/codespaces", "title": "List codespaces for the organization", "category": "codespaces", "subcategory": "organizations", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 3, "codespaces": [ { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "recent_folders": [] }, { "id": 1, "name": "monalisa-octocat-hello-world-3f89ada1j3", "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/foobar/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", "recent_folders": [] }, { "id": 1, "name": "monalisa-octocat-hello-world-f8adfad99a", "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", "recent_folders": [] } ] }, "schema": { "type": "object", "required": [ "total_count", "codespaces" ], "properties": { "total_count": { "type": "integer" }, "codespaces": { "type": "array", "items": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists the codespaces associated to a specified organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/members/{username}/codespaces/{codespace_name}", "title": "Delete a codespace from the organization", "category": "codespaces", "subcategory": "organizations", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "codespace_name", "in": "path", "required": true, "description": "The name of the codespace.
", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "202", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME", "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "202", "description": "Accepted
" } } ], "previews": [], "descriptionHTML": "Deletes a user's codespace.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Accepted
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop", "title": "Stop a codespace for an organization user", "category": "codespaces", "subcategory": "organizations", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "codespace_name", "in": "path", "required": true, "description": "The name of the codespace.
", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME", "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "retention_period_minutes": 43200, "retention_expires_at": null, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [], "template": null }, "schema": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ "monalisa-octocat-hello-world-g4wpq6h95q" ] }, "display_name": { "description": "Display name for this codespace.", "type": [ "string", "null" ], "examples": [ "bookish space pancake" ] }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": [ "string", "null" ], "examples": [ "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "anyOf": [ { "type": "null" }, { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "examples": [ "standardLinux" ] }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ "4 cores, 8 GB RAM, 64 GB storage" ] }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "examples": [ "linux" ] }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "examples": [ 68719476736 ] }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "examples": [ 8589934592 ] }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "examples": [ 4 ] }, "prebuild_availability": { "type": [ "string", "null" ], "description": "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.", "enum": [ "none", "ready", "in_progress", null ], "examples": [ "ready" ] } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ] } ] }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], "examples": [ ".devcontainer/example/devcontainer.json" ] }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": [ "boolean", "null" ], "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "type": "string", "examples": [ "Available" ] }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "examples": [ 0 ] }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "examples": [ 0 ] }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "examples": [ "main" ] } } }, "location": { "description": "The Azure region where this codespace is located.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "type": "string", "examples": [ "WestUs2" ] }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": [ "integer", "null" ], "examples": [ 60 ] }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": [ "string", "null" ], "format": "uri" }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": [ "array", "null" ], "items": { "type": "string" } } } }, "pending_operation": { "description": "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.", "type": [ "boolean", "null" ] }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": [ "string", "null" ] }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": [ "string", "null" ] }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": [ "integer", "null" ], "examples": [ 60 ] }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T20:01:12Z" ] }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": [ "string", "null" ], "examples": [ "you've used 100% of your spending limit for Codespaces" ] } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } } ], "previews": [], "descriptionHTML": "Stops a user's codespace.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] } ], "repository-secrets": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codespaces/secrets", "title": "List repository secrets", "category": "codespaces", "subcategory": "repository-secrets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "secrets": [ { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "all" }, { "name": "GIST_ID", "created_at": "2020-01-10T10:59:22Z", "updated_at": "2020-01-11T11:59:22Z", "visibility": "all" } ] }, "schema": { "type": "object", "required": [ "total_count", "secrets" ], "properties": { "total_count": { "type": "integer" }, "secrets": { "type": "array", "items": { "title": "Codespaces Secret", "description": "Set repository secrets for GitHub Codespaces.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "type": "string", "examples": [ "SECRET_TOKEN" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "created_at", "updated_at" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the codespaces_secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codespaces/secrets/public-key", "title": "Get a repository public key", "category": "codespaces", "subcategory": "repository-secrets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" }, "schema": { "title": "CodespacesPublicKey", "description": "The public key used for setting Codespaces secrets.", "type": "object", "properties": { "key_id": { "description": "The identifier for the key.", "type": "string", "examples": [ "1234567" ] }, "key": { "description": "The Base64 encoded public key.", "type": "string", "examples": [ "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" ] }, "id": { "type": "integer", "examples": [ 2 ] }, "url": { "type": "string", "examples": [ "https://api.github.com/user/keys/2" ] }, "title": { "type": "string", "examples": [ "ssh-rsa AAAAB3NzaC1yc2EAAA" ] }, "created_at": { "type": "string", "examples": [ "2011-01-26T19:01:12Z" ] } }, "required": [ "key_id", "key" ] } } } ], "previews": [], "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the codespaces_secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}", "title": "Get a repository secret", "category": "codespaces", "subcategory": "repository-secrets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "all" }, "schema": { "title": "Codespaces Secret", "description": "Set repository secrets for GitHub Codespaces.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "type": "string", "examples": [ "SECRET_TOKEN" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the codespaces_secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}", "title": "Create or update a repository secret", "category": "codespaces", "subcategory": "repository-secrets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "encrypted_value", "in": "body", "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
" }, { "type": "string", "name": "key_id", "in": "body", "description": "ID of the key you used to encrypt the secret.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "201", "request": { "contentType": "application/json", "description": "Example 1: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" }, "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "201", "description": "Response when creating a secret
" } }, { "key": "204", "request": { "contentType": "application/json", "description": "Example 2: Status Code 204", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" }, "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response when updating a secret
" } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Response when creating a secret
" }, { "httpStatusCode": "204", "description": "Response when updating a secret
" } ], "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the codespaces_secrets repository\npermission to use this endpoint.
Example of encrypting a secret using Node.js
\nEncrypt your secret using the tweetsodium library.
\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\nExample of encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\nExample of encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\nExample of encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\nThe account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the codespaces_secrets repository permission to use this endpoint.
No Content
" } ] } ], "secrets": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/secrets", "title": "List secrets for the authenticated user", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "secrets": [ { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "all" }, { "name": "GIST_ID", "created_at": "2020-01-10T10:59:22Z", "updated_at": "2020-01-11T11:59:22Z", "visibility": "all" } ] }, "schema": { "type": "object", "required": [ "total_count", "secrets" ], "properties": { "total_count": { "type": "integer" }, "secrets": { "type": "array", "items": { "title": "Codespaces Secret", "description": "Secrets for a GitHub Codespace.", "type": "object", "properties": { "name": { "description": "The name of the secret", "type": "string", "examples": [ "SECRET_NAME" ] }, "created_at": { "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "updated_at": { "description": "The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "visibility": { "description": "The type of repositories in the organization that the secret is visible to", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", "type": "string", "format": "uri", "examples": [ "https://api.github.com/user/secrets/SECRET_NAME/repositories" ] } }, "required": [ "name", "created_at", "updated_at", "visibility", "selected_repositories_url" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all secrets available for a user's Codespaces without revealing their\nencrypted values.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have read access to the codespaces_user_secrets user permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/secrets/public-key", "title": "Get public key for the authenticated user", "category": "codespaces", "subcategory": "secrets", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" }, "schema": { "title": "CodespacesUserPublicKey", "description": "The public key used for setting user Codespaces' Secrets.", "type": "object", "properties": { "key_id": { "description": "The identifier for the key.", "type": "string", "examples": [ "1234567" ] }, "key": { "description": "The Base64 encoded public key.", "type": "string", "examples": [ "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" ] } }, "required": [ "key_id", "key" ] } } } ], "previews": [], "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have read access to the codespaces_user_secrets user permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/secrets/{secret_name}", "title": "Get a secret for the authenticated user", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "CODESPACE_GH_SECRET", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/user/codespaces/secrets/CODESPACE_GH_SECRET/repositories" }, "schema": { "title": "Codespaces Secret", "description": "Secrets for a GitHub Codespace.", "type": "object", "properties": { "name": { "description": "The name of the secret", "type": "string", "examples": [ "SECRET_NAME" ] }, "created_at": { "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "updated_at": { "description": "The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "visibility": { "description": "The type of repositories in the organization that the secret is visible to", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", "type": "string", "format": "uri", "examples": [ "https://api.github.com/user/secrets/SECRET_NAME/repositories" ] } }, "required": [ "name", "created_at", "updated_at", "visibility", "selected_repositories_url" ] } } } ], "previews": [], "descriptionHTML": "Gets a secret available to a user's codespaces without revealing its encrypted value.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have read access to the codespaces_user_secrets user permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/codespaces/secrets/{secret_name}", "title": "Create or update a secret for the authenticated user", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "encrypted_value", "in": "body", "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get the public key for the authenticated user endpoint.
" }, { "type": "string", "name": "key_id", "in": "body", "description": "ID of the key you used to encrypt the secret.
", "isRequired": true }, { "type": "array of strings", "name": "selected_repository_ids", "in": "body", "description": "An array of repository ids that can access the user secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Set selected repositories for a user secret, and Remove a selected repository from a user secret endpoints.
" } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "201", "request": { "contentType": "application/json", "description": "Example 1: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "selected_repository_ids": [ "1234567", "2345678" ] }, "parameters": { "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "201", "description": "Response after successfully creaing a secret
" } }, { "key": "204", "request": { "contentType": "application/json", "description": "Example 2: Status Code 204", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "selected_repository_ids": [ "1234567", "2345678" ] }, "parameters": { "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response after successfully updating a secret
" } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Response after successfully creaing a secret
" }, { "httpStatusCode": "204", "description": "Response after successfully updating a secret
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "descriptionHTML": "Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must also have Codespaces access to use this endpoint.
GitHub Apps must have read access to the codespaces_user_secrets user permission and codespaces_secrets repository permission on all referenced repositories to use this endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the tweetsodium library.
\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\nThe name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have write access to the codespaces_user_secrets user permission to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/secrets/{secret_name}/repositories", "title": "List selected repositories for a user secret", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "organization": null, "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "delete_branch_on_merge": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "forks": 1, "open_issues": 1, "watchers": 1 } ] }, "schema": { "type": "object", "required": [ "total_count", "repositories" ], "properties": { "total_count": { "type": "integer" }, "repositories": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } } } ], "previews": [], "descriptionHTML": "List the repositories that have been granted the ability to use a user's codespace secret.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have read access to the codespaces_user_secrets user permission and write access to the codespaces_secrets repository permission on all referenced repositories to use this endpoint.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/codespaces/secrets/{secret_name}/repositories", "title": "Set selected repositories for a user secret", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of integers", "name": "selected_repository_ids", "in": "body", "description": "An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Add a selected repository to a user secret, and Remove a selected repository from a user secret endpoints.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ "1296269", "1296280" ] }, "parameters": { "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "No Content when repositories were added to the selected list
" } } ], "previews": [], "descriptionHTML": "Select the repositories that will use a user's codespace secret.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have write access to the codespaces_user_secrets user permission and write access to the codespaces_secrets repository permission on all referenced repositories to use this endpoint.
No Content when repositories were added to the selected list
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", "title": "Add a selected repository to a user secret", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "No Content when repository was added to the selected list
" } } ], "previews": [], "descriptionHTML": "Adds a repository to the selected repositories for a user's codespace secret.\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.\nGitHub Apps must have write access to the codespaces_user_secrets user permission and write access to the codespaces_secrets repository permission on the referenced repository to use this endpoint.
No Content when repository was added to the selected list
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", "title": "Remove a selected repository from a user secret", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "No Content when repository was removed from the selected list
" } } ], "previews": [], "descriptionHTML": "Removes a repository from the selected repositories for a user's codespace secret.\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.\nGitHub Apps must have write access to the codespaces_user_secrets user permission to use this endpoint.
No Content when repository was removed from the selected list
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] } ] }, "collaborators": { "collaborators": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", "subcategory": "collaborators", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "affiliation", "description": "Filter collaborators returned by their affiliation. outside means all outside collaborators of an organization-owned repository. direct means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. all means all collaborators the authenticated user can see.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false, "permissions": { "pull": true, "triage": true, "push": true, "maintain": false, "admin": false }, "role_name": "write" } ], "schema": { "type": "array", "items": { "title": "Collaborator", "description": "Collaborator", "type": "object", "properties": { "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "email": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "push", "admin" ] }, "role_name": { "type": "string", "examples": [ "admin" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "role_name" ] } } } } ], "previews": [], "descriptionHTML": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.
\nTeam members will include the members of child teams.
\nYou must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Check if a user is a repository collaborator", "category": "collaborators", "subcategory": "collaborators", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response if user is a collaborator
" } } ], "previews": [], "descriptionHTML": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
\nTeam members will include the members of child teams.
\nYou must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.
Response if user is a collaborator
" }, { "httpStatusCode": "404", "description": "Not Found if user is not a collaborator
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", "subcategory": "collaborators", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "permission", "in": "body", "description": "The permission to grant the collaborator. Only valid on organization-owned repositories. We accept the following permissions to be set: pull, triage, push, maintain, admin and you can also specify a custom repository role name, if the owning organization has defined any.
Response when a new invitation is created
", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "invitee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "inviter": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "permissions": "write", "created_at": "2016-06-13T14:52:50-05:00", "url": "https://api.github.com/user/repository_invitations/1296269", "html_url": "https://github.com/octocat/Hello-World/invitations" }, "schema": { "title": "Repository Invitation", "description": "Repository invitations let you manage who you collaborate with.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository invitation.", "type": "integer", "examples": [ 42 ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "invitee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "inviter": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "permissions": { "description": "The permission associated with the invitation.", "type": "string", "enum": [ "read", "write", "admin", "triage", "maintain" ], "examples": [ "read" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-06-13T14:52:50-05:00" ] }, "expired": { "description": "Whether or not the invitation has expired", "type": "boolean" }, "url": { "description": "URL for the repository invitation", "type": "string", "examples": [ "https://api.github.com/user/repository-invitations/1" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World/invitations" ] }, "node_id": { "type": "string" } }, "required": [ "id", "node_id", "permissions", "inviter", "invitee", "repository", "url", "html_url", "created_at" ] } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Response when a new invitation is created
" }, { "httpStatusCode": "204", "description": "Response when:
\n- \n
- an existing collaborator is added as a collaborator \n
- an organization member is added as an individual collaborator \n
- an existing team member (whose team is also a repository collaborator) is added as an individual collaborator \n
Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", "subcategory": "collaborators", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", "subcategory": "collaborators", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "if user has admin permissions
", "example": { "permission": "admin", "role_name": "admin", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, "schema": { "title": "Repository Collaborator Permission", "description": "Repository Collaborator Permission", "type": "object", "properties": { "permission": { "type": "string" }, "role_name": { "type": "string", "examples": [ "admin" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Collaborator", "description": "Collaborator", "type": "object", "properties": { "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "email": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "push", "admin" ] }, "role_name": { "type": "string", "examples": [ "admin" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "role_name" ] } ] } }, "required": [ "permission", "role_name", "user" ] } } } ], "previews": [], "descriptionHTML": "Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
if user has admin permissions
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "invitations": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/invitations", "title": "List repository invitations", "category": "collaborators", "subcategory": "invitations", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "invitee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "inviter": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "permissions": "write", "created_at": "2016-06-13T14:52:50-05:00", "url": "https://api.github.com/user/repository_invitations/1296269", "html_url": "https://github.com/octocat/Hello-World/invitations", "node_id": "MDQ6VXNlcjE=" } ], "schema": { "type": "array", "items": { "title": "Repository Invitation", "description": "Repository invitations let you manage who you collaborate with.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository invitation.", "type": "integer", "examples": [ 42 ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "invitee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "inviter": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "permissions": { "description": "The permission associated with the invitation.", "type": "string", "enum": [ "read", "write", "admin", "triage", "maintain" ], "examples": [ "read" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-06-13T14:52:50-05:00" ] }, "expired": { "description": "Whether or not the invitation has expired", "type": "boolean" }, "url": { "description": "URL for the repository invitation", "type": "string", "examples": [ "https://api.github.com/user/repository-invitations/1" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World/invitations" ] }, "node_id": { "type": "string" } }, "required": [ "id", "node_id", "permissions", "inviter", "invitee", "repository", "url", "html_url", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", "title": "Update a repository invitation", "category": "collaborators", "subcategory": "invitations", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invitation_id", "description": "The unique identifier of the invitation.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "permissions", "in": "body", "description": "The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.
Response
", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "invitee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "inviter": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "permissions": "write", "created_at": "2016-06-13T14:52:50-05:00", "expired": false, "url": "https://api.github.com/user/repository_invitations/1296269", "html_url": "https://github.com/octocat/Hello-World/invitations" }, "schema": { "title": "Repository Invitation", "description": "Repository invitations let you manage who you collaborate with.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository invitation.", "type": "integer", "examples": [ 42 ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "invitee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "inviter": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "permissions": { "description": "The permission associated with the invitation.", "type": "string", "enum": [ "read", "write", "admin", "triage", "maintain" ], "examples": [ "read" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-06-13T14:52:50-05:00" ] }, "expired": { "description": "Whether or not the invitation has expired", "type": "boolean" }, "url": { "description": "URL for the repository invitation", "type": "string", "examples": [ "https://api.github.com/user/repository-invitations/1" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World/invitations" ] }, "node_id": { "type": "string" } }, "required": [ "id", "node_id", "permissions", "inviter", "invitee", "repository", "url", "html_url", "created_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", "title": "Delete a repository invitation", "category": "collaborators", "subcategory": "invitations", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invitation_id", "description": "The unique identifier of the invitation.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "invitation_id": "INVITATION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/repository_invitations", "title": "List repository invitations for the authenticated user", "category": "collaborators", "subcategory": "invitations", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "invitee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "inviter": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "permissions": "write", "created_at": "2016-06-13T14:52:50-05:00", "url": "https://api.github.com/user/repository_invitations/1296269", "html_url": "https://github.com/octocat/Hello-World/invitations", "node_id": "MDQ6VXNlcjE=" } ], "schema": { "type": "array", "items": { "title": "Repository Invitation", "description": "Repository invitations let you manage who you collaborate with.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository invitation.", "type": "integer", "examples": [ 42 ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "invitee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "inviter": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "permissions": { "description": "The permission associated with the invitation.", "type": "string", "enum": [ "read", "write", "admin", "triage", "maintain" ], "examples": [ "read" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-06-13T14:52:50-05:00" ] }, "expired": { "description": "Whether or not the invitation has expired", "type": "boolean" }, "url": { "description": "URL for the repository invitation", "type": "string", "examples": [ "https://api.github.com/user/repository-invitations/1" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World/invitations" ] }, "node_id": { "type": "string" } }, "required": [ "id", "node_id", "permissions", "inviter", "invitee", "repository", "url", "html_url", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/user/repository_invitations/{invitation_id}", "title": "Accept a repository invitation", "category": "collaborators", "subcategory": "invitations", "parameters": [ { "name": "invitation_id", "description": "The unique identifier of the invitation.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/repository_invitations/{invitation_id}", "title": "Decline a repository invitation", "category": "collaborators", "subcategory": "invitations", "parameters": [ { "name": "invitation_id", "description": "The unique identifier of the invitation.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" } ] } ] }, "commits": { "commits": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", "subcategory": "commits", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sha", "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).
Only commits containing this file path will be returned.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "author", "description": "GitHub login or email address by which to filter by commit author.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", "commit": { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "author": { "name": "Monalisa Octocat", "email": "support@github.com", "date": "2011-04-14T16:00:49Z" }, "committer": { "name": "Monalisa Octocat", "email": "support@github.com", "date": "2011-04-14T16:00:49Z" }, "message": "Fix all the bugs", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" }, "comment_count": 0, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "committer": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" } ] } ], "schema": { "type": "array", "items": { "title": "Commit", "description": "Commit", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "sha": { "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "node_id": { "type": "string", "examples": [ "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" ] }, "commit": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "message": { "type": "string", "examples": [ "Fix all the bugs" ] }, "comment_count": { "type": "integer", "examples": [ 0 ] }, "tree": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "827efc6d56897b048c772eb4087f854f46256132" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" ] } }, "required": [ "sha", "url" ] }, "verification": { "title": "Verification", "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "payload": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "payload", "signature" ] } }, "required": [ "author", "committer", "comment_count", "message", "tree", "url" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" ] } }, "required": [ "sha", "url" ] } }, "stats": { "type": "object", "properties": { "additions": { "type": "integer" }, "deletions": { "type": "integer" }, "total": { "type": "integer" } } }, "files": { "type": "array", "items": { "title": "Diff Entry", "description": "Diff Entry", "type": "object", "properties": { "sha": { "type": "string", "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] }, "filename": { "type": "string", "examples": [ "file1.txt" ] }, "status": { "type": "string", "enum": [ "added", "removed", "modified", "renamed", "copied", "changed", "unchanged" ], "examples": [ "added" ] }, "additions": { "type": "integer", "examples": [ 103 ] }, "deletions": { "type": "integer", "examples": [ 21 ] }, "changes": { "type": "integer", "examples": [ 124 ] }, "blob_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "raw_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "contents_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "patch": { "type": "string", "examples": [ "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" ] }, "previous_filename": { "type": "string", "examples": [ "file.txt" ] } }, "required": [ "additions", "blob_url", "changes", "contents_url", "deletions", "filename", "raw_url", "sha", "status" ] } } }, "required": [ "url", "sha", "node_id", "html_url", "comments_url", "commit", "author", "committer", "parents" ] } } } } ], "previews": [], "descriptionHTML": "Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "title": "List branches for HEAD commit", "category": "commits", "subcategory": "commits", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "commit_sha", "description": "The SHA of the commit.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "commit_sha": "COMMIT_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "name": "branch_5", "commit": { "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" }, "protected": false } ], "schema": { "type": "array", "items": { "title": "Branch Short", "description": "Branch Short", "type": "object", "properties": { "name": { "type": "string" }, "commit": { "type": "object", "properties": { "sha": { "type": "string" }, "url": { "type": "string" } }, "required": [ "sha", "url" ] }, "protected": { "type": "boolean" } }, "required": [ "name", "commit", "protected" ] } } } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "title": "List pull requests associated with a commit", "category": "commits", "subcategory": "commits", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "commit_sha", "description": "The SHA of the commit.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "commit_sha": "COMMIT_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "number": 1347, "state": "open", "locked": true, "title": "Amazing new feature", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Please pull these awesome changes in!", "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "active_lock_reason": "too heated", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true } ], "requested_reviewers": [ { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false } ], "requested_teams": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "head": { "label": "octocat:new-topic", "ref": "new-topic", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } }, "base": { "label": "octocat:master", "ref": "master", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } }, "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1347" }, "issue": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, "comments": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "review_comments": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" }, "review_comment": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "commits": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" }, "statuses": { "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } }, "author_association": "OWNER", "auto_merge": null, "draft": false } ], "schema": { "type": "array", "items": { "title": "Pull Request Simple", "description": "Pull Request Simple", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDExOlB1bGxSZXF1ZXN0MQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347" ] }, "diff_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.diff" ] }, "patch_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.patch" ] }, "issue_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] }, "commits_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" ] }, "review_comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" ] }, "review_comment_url": { "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "number": { "type": "integer", "examples": [ 1347 ] }, "state": { "type": "string", "examples": [ "open" ] }, "locked": { "type": "boolean", "examples": [ true ] }, "title": { "type": "string", "examples": [ "new-feature" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "type": [ "string", "null" ], "examples": [ "Please pull these awesome changes" ] }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "default": { "type": "boolean" } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "active_lock_reason": { "type": [ "string", "null" ], "examples": [ "too heated" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merged_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merge_commit_sha": { "type": [ "string", "null" ], "examples": [ "e5bd3914e2e596debea16f433f57875b5b90bcd6" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_reviewers": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_teams": { "type": [ "array", "null" ], "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "base": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "_links": { "type": "object", "properties": { "comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "commits": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "statuses": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "html": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "issue": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comment": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "self": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "comments", "commits", "statuses", "html", "issue", "review_comments", "review_comment", "self" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "auto_merge": { "title": "Auto merge", "description": "The status of auto merging a pull request.", "type": [ "object", "null" ], "properties": { "enabled_by": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "merge_method": { "type": "string", "description": "The merge method to use.", "enum": [ "merge", "squash", "rebase" ] }, "commit_title": { "type": "string", "description": "Title for the merge commit message." }, "commit_message": { "type": "string", "description": "Commit message for the merge commit." } }, "required": [ "enabled_by", "merge_method", "commit_title", "commit_message" ] }, "draft": { "description": "Indicates whether or not the pull request is a draft.", "type": "boolean", "examples": [ false ] } }, "required": [ "_links", "assignee", "labels", "base", "body", "closed_at", "comments_url", "commits_url", "created_at", "diff_url", "head", "html_url", "id", "node_id", "issue_url", "merge_commit_sha", "merged_at", "milestone", "number", "patch_url", "review_comment_url", "review_comments_url", "statuses_url", "state", "locked", "title", "updated_at", "url", "user", "author_association", "auto_merge" ] } } } } ], "previews": [], "descriptionHTML": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", "subcategory": "commits", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "ref", "description": "ref parameter
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", "commit": { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "author": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "committer": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "message": "Fix all the bugs", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" }, "comment_count": 0, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "committer": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" } ], "stats": { "additions": 104, "deletions": 4, "total": 108 }, "files": [ { "filename": "file1.txt", "additions": 10, "deletions": 2, "changes": 12, "status": "modified", "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", "patch": "@@ -29,7 +29,7 @@\n....." } ] }, "schema": { "title": "Commit", "description": "Commit", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "sha": { "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "node_id": { "type": "string", "examples": [ "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" ] }, "commit": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "message": { "type": "string", "examples": [ "Fix all the bugs" ] }, "comment_count": { "type": "integer", "examples": [ 0 ] }, "tree": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "827efc6d56897b048c772eb4087f854f46256132" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" ] } }, "required": [ "sha", "url" ] }, "verification": { "title": "Verification", "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "payload": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "payload", "signature" ] } }, "required": [ "author", "committer", "comment_count", "message", "tree", "url" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" ] } }, "required": [ "sha", "url" ] } }, "stats": { "type": "object", "properties": { "additions": { "type": "integer" }, "deletions": { "type": "integer" }, "total": { "type": "integer" } } }, "files": { "type": "array", "items": { "title": "Diff Entry", "description": "Diff Entry", "type": "object", "properties": { "sha": { "type": "string", "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] }, "filename": { "type": "string", "examples": [ "file1.txt" ] }, "status": { "type": "string", "enum": [ "added", "removed", "modified", "renamed", "copied", "changed", "unchanged" ], "examples": [ "added" ] }, "additions": { "type": "integer", "examples": [ 103 ] }, "deletions": { "type": "integer", "examples": [ 21 ] }, "changes": { "type": "integer", "examples": [ 124 ] }, "blob_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "raw_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "contents_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "patch": { "type": "string", "examples": [ "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" ] }, "previous_filename": { "type": "string", "examples": [ "file.txt" ] } }, "required": [ "additions", "blob_url", "changes", "contents_url", "deletions", "filename", "raw_url", "sha", "status" ] } } }, "required": [ "url", "sha", "node_id", "html_url", "comments_url", "commit", "author", "committer", "parents" ] } } } ], "previews": [], "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "500", "description": "Internal Error
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", "subcategory": "commits", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "basehead", "description": "The base branch and head branch to compare. This parameter expects the format {base}...{head}.
Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic", "html_url": "https://github.com/octocat/Hello-World/compare/master...topic", "permalink_url": "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17", "diff_url": "https://github.com/octocat/Hello-World/compare/master...topic.diff", "patch_url": "https://github.com/octocat/Hello-World/compare/master...topic.patch", "base_commit": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", "commit": { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "author": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "committer": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "message": "Fix all the bugs", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" }, "comment_count": 0, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "committer": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" } ] }, "merge_base_commit": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", "commit": { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "author": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "committer": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "message": "Fix all the bugs", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" }, "comment_count": 0, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "committer": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" } ] }, "status": "behind", "ahead_by": 1, "behind_by": 2, "total_commits": 1, "commits": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", "commit": { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "author": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "committer": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "message": "Fix all the bugs", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" }, "comment_count": 0, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "committer": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" } ] } ], "files": [ { "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", "filename": "file1.txt", "status": "added", "additions": 103, "deletions": 21, "changes": 124, "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e", "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" } ] }, "schema": { "title": "Commit Comparison", "description": "Commit Comparison", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/compare/master...topic" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/compare/master...topic" ] }, "permalink_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17" ] }, "diff_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/compare/master...topic.diff" ] }, "patch_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/compare/master...topic.patch" ] }, "base_commit": { "title": "Commit", "description": "Commit", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "sha": { "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "node_id": { "type": "string", "examples": [ "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" ] }, "commit": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "message": { "type": "string", "examples": [ "Fix all the bugs" ] }, "comment_count": { "type": "integer", "examples": [ 0 ] }, "tree": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "827efc6d56897b048c772eb4087f854f46256132" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" ] } }, "required": [ "sha", "url" ] }, "verification": { "title": "Verification", "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "payload": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "payload", "signature" ] } }, "required": [ "author", "committer", "comment_count", "message", "tree", "url" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" ] } }, "required": [ "sha", "url" ] } }, "stats": { "type": "object", "properties": { "additions": { "type": "integer" }, "deletions": { "type": "integer" }, "total": { "type": "integer" } } }, "files": { "type": "array", "items": { "title": "Diff Entry", "description": "Diff Entry", "type": "object", "properties": { "sha": { "type": "string", "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] }, "filename": { "type": "string", "examples": [ "file1.txt" ] }, "status": { "type": "string", "enum": [ "added", "removed", "modified", "renamed", "copied", "changed", "unchanged" ], "examples": [ "added" ] }, "additions": { "type": "integer", "examples": [ 103 ] }, "deletions": { "type": "integer", "examples": [ 21 ] }, "changes": { "type": "integer", "examples": [ 124 ] }, "blob_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "raw_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "contents_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "patch": { "type": "string", "examples": [ "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" ] }, "previous_filename": { "type": "string", "examples": [ "file.txt" ] } }, "required": [ "additions", "blob_url", "changes", "contents_url", "deletions", "filename", "raw_url", "sha", "status" ] } } }, "required": [ "url", "sha", "node_id", "html_url", "comments_url", "commit", "author", "committer", "parents" ] }, "merge_base_commit": { "title": "Commit", "description": "Commit", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "sha": { "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "node_id": { "type": "string", "examples": [ "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" ] }, "commit": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "message": { "type": "string", "examples": [ "Fix all the bugs" ] }, "comment_count": { "type": "integer", "examples": [ 0 ] }, "tree": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "827efc6d56897b048c772eb4087f854f46256132" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" ] } }, "required": [ "sha", "url" ] }, "verification": { "title": "Verification", "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "payload": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "payload", "signature" ] } }, "required": [ "author", "committer", "comment_count", "message", "tree", "url" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" ] } }, "required": [ "sha", "url" ] } }, "stats": { "type": "object", "properties": { "additions": { "type": "integer" }, "deletions": { "type": "integer" }, "total": { "type": "integer" } } }, "files": { "type": "array", "items": { "title": "Diff Entry", "description": "Diff Entry", "type": "object", "properties": { "sha": { "type": "string", "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] }, "filename": { "type": "string", "examples": [ "file1.txt" ] }, "status": { "type": "string", "enum": [ "added", "removed", "modified", "renamed", "copied", "changed", "unchanged" ], "examples": [ "added" ] }, "additions": { "type": "integer", "examples": [ 103 ] }, "deletions": { "type": "integer", "examples": [ 21 ] }, "changes": { "type": "integer", "examples": [ 124 ] }, "blob_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "raw_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "contents_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "patch": { "type": "string", "examples": [ "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" ] }, "previous_filename": { "type": "string", "examples": [ "file.txt" ] } }, "required": [ "additions", "blob_url", "changes", "contents_url", "deletions", "filename", "raw_url", "sha", "status" ] } } }, "required": [ "url", "sha", "node_id", "html_url", "comments_url", "commit", "author", "committer", "parents" ] }, "status": { "type": "string", "enum": [ "diverged", "ahead", "behind", "identical" ], "examples": [ "ahead" ] }, "ahead_by": { "type": "integer", "examples": [ 4 ] }, "behind_by": { "type": "integer", "examples": [ 5 ] }, "total_commits": { "type": "integer", "examples": [ 6 ] }, "commits": { "type": "array", "items": { "title": "Commit", "description": "Commit", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "sha": { "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "node_id": { "type": "string", "examples": [ "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" ] }, "commit": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "message": { "type": "string", "examples": [ "Fix all the bugs" ] }, "comment_count": { "type": "integer", "examples": [ 0 ] }, "tree": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "827efc6d56897b048c772eb4087f854f46256132" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" ] } }, "required": [ "sha", "url" ] }, "verification": { "title": "Verification", "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "payload": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "payload", "signature" ] } }, "required": [ "author", "committer", "comment_count", "message", "tree", "url" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" ] } }, "required": [ "sha", "url" ] } }, "stats": { "type": "object", "properties": { "additions": { "type": "integer" }, "deletions": { "type": "integer" }, "total": { "type": "integer" } } }, "files": { "type": "array", "items": { "title": "Diff Entry", "description": "Diff Entry", "type": "object", "properties": { "sha": { "type": "string", "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] }, "filename": { "type": "string", "examples": [ "file1.txt" ] }, "status": { "type": "string", "enum": [ "added", "removed", "modified", "renamed", "copied", "changed", "unchanged" ], "examples": [ "added" ] }, "additions": { "type": "integer", "examples": [ 103 ] }, "deletions": { "type": "integer", "examples": [ 21 ] }, "changes": { "type": "integer", "examples": [ 124 ] }, "blob_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "raw_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "contents_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "patch": { "type": "string", "examples": [ "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" ] }, "previous_filename": { "type": "string", "examples": [ "file.txt" ] } }, "required": [ "additions", "blob_url", "changes", "contents_url", "deletions", "filename", "raw_url", "sha", "status" ] } } }, "required": [ "url", "sha", "node_id", "html_url", "comments_url", "commit", "author", "committer", "parents" ] } }, "files": { "type": "array", "items": { "title": "Diff Entry", "description": "Diff Entry", "type": "object", "properties": { "sha": { "type": "string", "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] }, "filename": { "type": "string", "examples": [ "file1.txt" ] }, "status": { "type": "string", "enum": [ "added", "removed", "modified", "renamed", "copied", "changed", "unchanged" ], "examples": [ "added" ] }, "additions": { "type": "integer", "examples": [ 103 ] }, "deletions": { "type": "integer", "examples": [ 21 ] }, "changes": { "type": "integer", "examples": [ 124 ] }, "blob_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "raw_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "contents_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "patch": { "type": "string", "examples": [ "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" ] }, "previous_filename": { "type": "string", "examples": [ "file.txt" ] } }, "required": [ "additions", "blob_url", "changes", "contents_url", "deletions", "filename", "raw_url", "sha", "status" ] } } }, "required": [ "url", "html_url", "permalink_url", "diff_url", "patch_url", "base_commit", "merge_base_commit", "status", "ahead_by", "behind_by", "total_commits", "commits" ] } } } ], "previews": [], "descriptionHTML": "The basehead param is comprised of two parts: base and head. Both must be branch names in repo. To compare branches across other repositories in the same network as repo, use the format <USERNAME>:branch.
The response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.
The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.
Working with large comparisons
\nTo process a response with a large number of commits, you can use (per_page or page) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"Traversing with pagination.\"
When calling this API without any paging parameters (per_page or page), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ] } ], "comments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments", "title": "List commit comments for a repository", "category": "commits", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "Great stuff", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "author_association": "COLLABORATOR" } ], "schema": { "type": "array", "items": { "title": "Commit Comment", "description": "Commit Comment", "type": "object", "properties": { "html_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "body": { "type": "string" }, "path": { "type": [ "string", "null" ] }, "position": { "type": [ "integer", "null" ] }, "line": { "type": [ "integer", "null" ] }, "commit_id": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "url", "html_url", "id", "node_id", "user", "position", "line", "path", "commit_id", "body", "author_association", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", "title": "Get a commit comment", "category": "commits", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "Great stuff", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "author_association": "COLLABORATOR", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z" }, "schema": { "title": "Commit Comment", "description": "Commit Comment", "type": "object", "properties": { "html_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "body": { "type": "string" }, "path": { "type": [ "string", "null" ] }, "position": { "type": [ "integer", "null" ] }, "line": { "type": [ "integer", "null" ] }, "commit_id": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "url", "html_url", "id", "node_id", "user", "position", "line", "path", "commit_id", "body", "author_association", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", "title": "Update a commit comment", "category": "commits", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The contents of the comment
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Nice change" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "Nice change", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "author_association": "COLLABORATOR", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z" }, "schema": { "title": "Commit Comment", "description": "Commit Comment", "type": "object", "properties": { "html_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "body": { "type": "string" }, "path": { "type": [ "string", "null" ] }, "position": { "type": [ "integer", "null" ] }, "line": { "type": [ "integer", "null" ] }, "commit_id": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "url", "html_url", "id", "node_id", "user", "position", "line", "path", "commit_id", "body", "author_association", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", "title": "Delete a commit comment", "category": "commits", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", "title": "List commit comments", "category": "commits", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "commit_sha", "description": "The SHA of the commit.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "commit_sha": "COMMIT_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "Great stuff", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "author_association": "COLLABORATOR" } ], "schema": { "type": "array", "items": { "title": "Commit Comment", "description": "Commit Comment", "type": "object", "properties": { "html_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "body": { "type": "string" }, "path": { "type": [ "string", "null" ] }, "position": { "type": [ "integer", "null" ] }, "line": { "type": [ "integer", "null" ] }, "commit_id": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "url", "html_url", "id", "node_id", "user", "position", "line", "path", "commit_id", "body", "author_association", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Use the :commit_sha to specify the commit that will have its comments listed.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", "title": "Create a commit comment", "category": "commits", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "commit_sha", "description": "The SHA of the commit.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The contents of the comment.
", "isRequired": true }, { "type": "string", "name": "path", "in": "body", "description": "Relative path of the file to comment on.
" }, { "type": "integer", "name": "position", "in": "body", "description": "Line index in the diff to comment on.
" }, { "type": "integer", "name": "line", "in": "body", "description": "Deprecated. Use position parameter instead. Line number in the file to comment on.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff", "path": "file1.txt", "position": 4, "line": 1 }, "parameters": { "owner": "OWNER", "repo": "REPO", "commit_sha": "COMMIT_SHA" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "Great stuff", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "author_association": "COLLABORATOR", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z" }, "schema": { "title": "Commit Comment", "description": "Commit Comment", "type": "object", "properties": { "html_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "body": { "type": "string" }, "path": { "type": [ "string", "null" ] }, "position": { "type": [ "integer", "null" ] }, "line": { "type": [ "integer", "null" ] }, "commit_id": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "url", "html_url", "id", "node_id", "user", "position", "line", "path", "commit_id", "body", "author_association", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Create a comment for a commit using its :commit_sha.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "statuses": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", "title": "Get the combined status for a specific reference", "category": "commits", "subcategory": "statuses", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ref", "description": "ref parameter
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "state": "success", "statuses": [ { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "id": 1, "node_id": "MDY6U3RhdHVzMQ==", "state": "success", "description": "Build has completed successfully", "target_url": "https://ci.example.com/1000/output", "context": "continuous-integration/jenkins", "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z" }, { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "id": 2, "node_id": "MDY6U3RhdHVzMg==", "state": "success", "description": "Testing has completed successfully", "target_url": "https://ci.example.com/2000/output", "context": "security/brakeman", "created_at": "2012-08-20T01:19:13Z", "updated_at": "2012-08-20T01:19:13Z" } ], "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "total_count": 2, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "commit_url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e", "url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status" }, "schema": { "title": "Combined Commit Status", "description": "Combined Commit Status", "type": "object", "properties": { "state": { "type": "string" }, "statuses": { "type": "array", "items": { "title": "Simple Commit Status", "type": "object", "properties": { "description": { "type": [ "string", "null" ] }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "state": { "type": "string" }, "context": { "type": "string" }, "target_url": { "type": [ "string", "null" ], "format": "uri" }, "required": { "type": [ "boolean", "null" ] }, "avatar_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": "string", "format": "uri" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "description", "id", "node_id", "state", "context", "target_url", "avatar_url", "url", "created_at", "updated_at" ] } }, "sha": { "type": "string" }, "total_count": { "type": "integer" }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "commit_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" } }, "required": [ "state", "sha", "total_count", "statuses", "repository", "commit_url", "url" ] } } } ], "previews": [], "descriptionHTML": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
\nAdditionally, a combined state is returned. The state is one of:
- \n
- failure if any of the contexts report as
errororfailure\n - pending if there are no statuses or a context is
pending\n - success if the latest status for all contexts is
success\n
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses", "title": "List commit statuses for a reference", "category": "commits", "subcategory": "statuses", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ref", "description": "ref parameter
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "id": 1, "node_id": "MDY6U3RhdHVzMQ==", "state": "success", "description": "Build has completed successfully", "target_url": "https://ci.example.com/1000/output", "context": "continuous-integration/jenkins", "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } ], "schema": { "type": "array", "items": { "title": "Status", "description": "The status of a commit.", "type": "object", "properties": { "url": { "type": "string" }, "avatar_url": { "type": [ "string", "null" ] }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "state": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "target_url": { "type": [ "string", "null" ] }, "context": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "url", "avatar_url", "id", "node_id", "state", "description", "target_url", "context", "created_at", "updated_at", "creator" ] } } } } ], "previews": [], "descriptionHTML": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
\nThis resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.
OK
" }, { "httpStatusCode": "301", "description": "Moved permanently
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", "title": "Create a commit status", "category": "commits", "subcategory": "statuses", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sha", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "description": "" } ], "bodyParameters": [ { "type": "string", "name": "state", "in": "body", "description": "The state of the status.
", "isRequired": true, "enum": [ "error", "failure", "pending", "success" ] }, { "type": "string or null", "name": "target_url", "in": "body", "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
\nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
\nhttp://ci.example.com/user/repo/build/sha
A short description of the status.
" }, { "type": "string", "name": "context", "in": "body", "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.
", "default": "default" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "success", "target_url": "https://example.com/build/status", "description": "The build succeeded!", "context": "continuous-integration/jenkins" }, "parameters": { "owner": "OWNER", "repo": "REPO", "sha": "SHA" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "id": 1, "node_id": "MDY6U3RhdHVzMQ==", "state": "success", "description": "Build has completed successfully", "target_url": "https://ci.example.com/1000/output", "context": "continuous-integration/jenkins", "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, "schema": { "title": "Status", "description": "The status of a commit.", "type": "object", "properties": { "url": { "type": "string" }, "avatar_url": { "type": [ "string", "null" ] }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "state": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "target_url": { "type": [ "string", "null" ] }, "context": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "url", "avatar_url", "id", "node_id", "state", "description", "target_url", "context", "created_at", "updated_at", "creator" ] } } } ], "previews": [], "descriptionHTML": "Users with push access in a repository can create commit statuses for a given SHA.
\nNote: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.
Created
" } ] } ] }, "dependabot": { "secrets": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/dependabot/secrets", "title": "List organization secrets", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 3, "secrets": [ { "name": "MY_ARTIFACTORY_PASSWORD", "created_at": "2021-08-10T14:59:22Z", "updated_at": "2021-12-10T14:59:22Z", "visibility": "private" }, { "name": "NPM_TOKEN", "created_at": "2021-08-10T14:59:22Z", "updated_at": "2021-12-10T14:59:22Z", "visibility": "all" }, { "name": "GH_TOKEN", "created_at": "2021-08-10T14:59:22Z", "updated_at": "2021-12-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" } ] }, "schema": { "type": "object", "required": [ "total_count", "secrets" ], "properties": { "total_count": { "type": "integer" }, "secrets": { "type": "array", "items": { "title": "Dependabot Secret for an Organization", "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "type": "string", "examples": [ "SECRET_TOKEN" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "visibility": { "description": "Visibility of a secret", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" ] } }, "required": [ "name", "created_at", "updated_at", "visibility" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/dependabot/secrets/public-key", "title": "Get an organization public key", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" }, "schema": { "title": "DependabotPublicKey", "description": "The public key used for setting Dependabot Secrets.", "type": "object", "properties": { "key_id": { "description": "The identifier for the key.", "type": "string", "examples": [ "1234567" ] }, "key": { "description": "The Base64 encoded public key.", "type": "string", "examples": [ "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" ] } }, "required": [ "key_id", "key" ] } } } ], "previews": [], "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", "title": "Get an organization secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "NPM_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" }, "schema": { "title": "Dependabot Secret for an Organization", "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "type": "string", "examples": [ "SECRET_TOKEN" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "visibility": { "description": "Visibility of a secret", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" ] } }, "required": [ "name", "created_at", "updated_at", "visibility" ] } } } ], "previews": [], "descriptionHTML": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", "title": "Create or update an organization secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "encrypted_value", "in": "body", "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.
" }, { "type": "string", "name": "key_id", "in": "body", "description": "ID of the key you used to encrypt the secret.
" }, { "type": "string", "name": "visibility", "in": "body", "description": "Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Response when creating a secret
", "example": null, "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false } } }, { "key": "204", "request": { "contentType": "application/json", "description": "Example 2: Status Code 204", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ "1296269", "1296280" ] }, "parameters": { "org": "ORG", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response when updating a secret
" } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Response when creating a secret
" }, { "httpStatusCode": "204", "description": "Response when updating a secret
" } ], "descriptionHTML": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the tweetsodium library.
\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\nThe organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", "title": "List selected repositories for an organization secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } ] }, "schema": { "type": "object", "required": [ "total_count", "repositories" ], "properties": { "total_count": { "type": "integer" }, "repositories": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", "title": "Set selected repositories for an organization secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of integers", "name": "selected_repository_ids", "in": "body", "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.
Response
" } } ], "previews": [], "descriptionHTML": "Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", "title": "Add selected repository to an organization secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "No Content when repository was added to the selected list
" } } ], "previews": [], "descriptionHTML": "Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
No Content when repository was added to the selected list
" }, { "httpStatusCode": "409", "description": "Conflict when visibility type is not set to selected
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", "title": "Remove selected repository from an organization secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "Response when repository was removed from the selected list
" } } ], "previews": [], "descriptionHTML": "Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
Response when repository was removed from the selected list
" }, { "httpStatusCode": "409", "description": "Conflict when visibility type not set to selected
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/dependabot/secrets", "title": "List repository secrets", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "secrets": [ { "name": "AZURE_DEVOPS_PAT", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" }, { "name": "MY_ARTIFACTORY_PASSWORD", "created_at": "2020-01-10T10:59:22Z", "updated_at": "2020-01-11T11:59:22Z" } ] }, "schema": { "type": "object", "required": [ "total_count", "secrets" ], "properties": { "total_count": { "type": "integer" }, "secrets": { "type": "array", "items": { "title": "Dependabot Secret", "description": "Set secrets for Dependabot.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "type": "string", "examples": [ "MY_ARTIFACTORY_PASSWORD" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "created_at", "updated_at" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/public-key", "title": "Get a repository public key", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" }, "schema": { "title": "DependabotPublicKey", "description": "The public key used for setting Dependabot Secrets.", "type": "object", "properties": { "key_id": { "description": "The identifier for the key.", "type": "string", "examples": [ "1234567" ] }, "key": { "description": "The Base64 encoded public key.", "type": "string", "examples": [ "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" ] } }, "required": [ "key_id", "key" ] } } } ], "previews": [], "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", "title": "Get a repository secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "MY_ARTIFACTORY_PASSWORD", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" }, "schema": { "title": "Dependabot Secret", "description": "Set secrets for Dependabot.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "type": "string", "examples": [ "MY_ARTIFACTORY_PASSWORD" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", "title": "Create or update a repository secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "encrypted_value", "in": "body", "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
" }, { "type": "string", "name": "key_id", "in": "body", "description": "ID of the key you used to encrypt the secret.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" }, "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response when creating a secret
", "example": null, "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false } } }, { "key": "204", "request": { "contentType": "application/json", "description": "Example 2: Status Code 204", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" }, "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response when updating a secret
" } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Response when creating a secret
" }, { "httpStatusCode": "204", "description": "Response when updating a secret
" } ], "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the tweetsodium library.
\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\nThe account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.
No Content
" } ] } ] }, "dependency-graph": { "dependency-review": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}", "title": "Get a diff of the dependencies between commits", "category": "dependency-graph", "subcategory": "dependency-review", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "basehead", "description": "The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format {base}...{head}.
The full path, relative to the repository root, of the dependency manifest file.
", "in": "query", "required": false, "schema": { "type": "string" } } ], "bodyParameters": [], "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "basehead": "BASEHEAD" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "change_type": "removed", "manifest": "package.json", "ecosystem": "npm", "name": "helmet", "version": "4.6.0", "package_url": "pkg:npm/helmet@4.6.0", "license": "MIT", "source_repository_url": "https://github.com/helmetjs/helmet", "vulnerabilities": [] }, { "change_type": "added", "manifest": "package.json", "ecosystem": "npm", "name": "helmet", "version": "5.0.0", "package_url": "pkg:npm/helmet@5.0.0", "license": "MIT", "source_repository_url": "https://github.com/helmetjs/helmet", "vulnerabilities": [] }, { "change_type": "added", "manifest": "Gemfile", "ecosystem": "rubygems", "name": "ruby-openid", "version": "2.7.0", "package_url": "pkg:gem/ruby-openid@2.7.0", "license": null, "source_repository_url": "https://github.com/openid/ruby-openid", "vulnerabilities": [ { "severity": "critical", "advisory_ghsa_id": "GHSA-fqfj-cmh6-hj49", "advisory_summary": "Ruby OpenID", "advisory_url": "https://github.com/advisories/GHSA-fqfj-cmh6-hj49" } ] } ], "schema": { "title": "Dependency Graph Diff", "description": "A diff of the dependencies between two commits.", "type": "array", "items": { "type": "object", "properties": { "change_type": { "type": "string", "enum": [ "added", "removed" ] }, "manifest": { "type": "string", "examples": [ "path/to/package-lock.json" ] }, "ecosystem": { "type": "string", "examples": [ "npm" ] }, "name": { "type": "string", "examples": [ "@actions/core" ] }, "version": { "type": "string", "examples": [ "1.0.0" ] }, "package_url": { "type": [ "string", "null" ], "examples": [ "pkg:/npm/%40actions/core@1.1.0" ] }, "license": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "source_repository_url": { "type": [ "string", "null" ], "examples": [ "https://github.com/github/actions" ] }, "vulnerabilities": { "type": "array", "items": { "type": "object", "properties": { "severity": { "type": "string", "examples": [ "critical" ] }, "advisory_ghsa_id": { "type": "string", "examples": [ "GHSA-rf4j-j272-fj86" ] }, "advisory_summary": { "type": "string", "examples": [ "A summary of the advisory." ] }, "advisory_url": { "type": "string", "examples": [ "https://github.com/advisories/GHSA-rf4j-j272-fj86" ] } }, "required": [ "severity", "advisory_ghsa_id", "advisory_summary", "advisory_url" ] } } }, "required": [ "change_type", "manifest", "ecosystem", "name", "version", "package_url", "license", "source_repository_url", "vulnerabilities" ] } } } } ], "previews": [], "descriptionHTML": "Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "dependency-submission": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/dependency-graph/snapshots", "title": "Create a snapshot of dependencies for a repository", "category": "dependency-graph", "subcategory": "dependency-submission", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "integer", "name": "version", "in": "body", "description": "The version of the repository snapshot submission.
", "isRequired": true }, { "type": "object", "name": "job", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "id", "description": "The external ID of the job.
", "isRequired": true }, { "type": "string", "name": "correlator", "description": "Correlator provides a key that is used to group snapshots submitted over time. Only the \"latest\" submitted snapshot for a given combination of job.correlator and detector.name will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given \"wave\" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.
The url for the job.
" } ] }, { "type": "string", "name": "sha", "in": "body", "description": "The commit SHA associated with this dependency snapshot.
", "isRequired": true }, { "type": "string", "name": "ref", "in": "body", "description": "The repository branch that triggered this snapshot.
", "isRequired": true }, { "type": "object", "name": "detector", "in": "body", "description": "A description of the detector used.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "name", "description": "The name of the detector used.
", "isRequired": true }, { "type": "string", "name": "version", "description": "The version of the detector used.
", "isRequired": true }, { "type": "string", "name": "url", "description": "The url of the detector used.
", "isRequired": true } ] }, { "type": "object", "name": "metadata", "in": "body", "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
" }, { "type": "object", "name": "manifests", "in": "body", "description": "A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.
", "childParamsGroups": [ { "type": "object", "name": "key", "description": "A user-defined key to represent an item in manifests.
The name of the manifest.
", "isRequired": true }, { "type": "object", "name": "file", "description": "", "childParamsGroups": [ { "type": "string", "name": "source_location", "description": "The path of the manifest file relative to the root of the Git repository.
" } ] }, { "type": "object", "name": "metadata", "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
" }, { "type": "object", "name": "resolved", "description": "A collection of resolved package dependencies.
", "childParamsGroups": [ { "type": "object", "name": "key", "description": "A user-defined key to represent an item in resolved.
Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.
" }, { "type": "object", "name": "metadata", "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
" }, { "type": "string", "name": "relationship", "description": "A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.
", "enum": [ "direct", "indirect" ] }, { "type": "string", "name": "scope", "description": "A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.
", "enum": [ "runtime", "development" ] }, { "type": "array of strings", "name": "dependencies", "description": "Array of package-url (PURLs) of direct child dependencies.
" } ] } ] } ] } ] }, { "type": "string", "name": "scanned", "in": "body", "description": "The time at which the snapshot was scanned.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "example-of-a-dependency-submission", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "version": 0, "sha": "ce587453ced02b1526dfb4cb910479d431683101", "ref": "refs/heads/main", "job": { "correlator": "yourworkflowname_youractionname", "id": "yourrunid" }, "detector": { "name": "octo-detector", "version": "0.0.1", "url": "https://github.com/octo-org/octo-repo" }, "scanned": "2022-06-14T20:25:00Z", "manifests": { "package-lock.json": { "name": "package-lock.json", "file": { "source_location": "src/package-lock.json" }, "resolved": { "@actions/core": { "package_url": "pkg:/npm/%40actions/core@1.1.9", "dependencies": [ "@actions/http-client" ] }, "@actions/http-client": { "package_url": "pkg:/npm/%40actions/http-client@1.0.7", "dependencies": [ "tunnel" ] }, "tunnel": { "package_url": "pkg:/npm/tunnel@0.0.6" } } } } }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 12345, "created_at": "2018-05-04T01:14:52Z", "message": "Dependency results for the repo have been successfully updated.", "result": "SUCCESS" }, "schema": { "type": "object", "required": [ "id", "created_at", "result", "message" ], "properties": { "id": { "type": "integer", "description": "ID of the created snapshot." }, "created_at": { "type": "string", "description": "The time at which the snapshot was created." }, "result": { "type": "string", "description": "Either \"SUCCESS\", \"ACCEPTED\", or \"INVALID\". \"SUCCESS\" indicates that the snapshot was successfully created and the repository's dependencies were updated. \"ACCEPTED\" indicates that the snapshot was successfully created, but the repository's dependencies were not updated. \"INVALID\" indicates that the snapshot was malformed." }, "message": { "type": "string", "description": "A message providing further details about the result, such as why the dependencies were not updated." } } } } } ], "previews": [], "descriptionHTML": "Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the repo scope to use this endpoint for a repository that the requesting user has access to.
Created
" } ] } ] }, "deploy-keys": { "deploy-keys": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", "title": "List deploy keys", "category": "deploy-keys", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "key": "ssh-rsa AAA...", "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", "title": "octocat@octomac", "verified": true, "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", "last_used": "2022-01-10T15:53:42Z" } ], "schema": { "type": "array", "items": { "title": "Deploy Key", "description": "An SSH key granting access to a single repository.", "type": "object", "properties": { "id": { "type": "integer" }, "key": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "verified": { "type": "boolean" }, "created_at": { "type": "string" }, "read_only": { "type": "boolean" }, "added_by": { "type": [ "string", "null" ] }, "last_used": { "type": [ "string", "null" ] } }, "required": [ "id", "key", "url", "title", "verified", "created_at", "read_only" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "deploy-keys" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", "title": "Create a deploy key", "category": "deploy-keys", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "title", "in": "body", "description": "A name for the key.
" }, { "type": "string", "name": "key", "in": "body", "description": "The contents of the key.
", "isRequired": true }, { "type": "boolean", "name": "read_only", "in": "body", "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "octocat@octomac", "key": "ssh-rsa AAA...", "read_only": true }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "key": "ssh-rsa AAA...", "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", "title": "octocat@octomac", "verified": true, "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", "last_used": "2022-01-10T15:53:42Z" }, "schema": { "title": "Deploy Key", "description": "An SSH key granting access to a single repository.", "type": "object", "properties": { "id": { "type": "integer" }, "key": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "verified": { "type": "boolean" }, "created_at": { "type": "string" }, "read_only": { "type": "boolean" }, "added_by": { "type": [ "string", "null" ] }, "last_used": { "type": [ "string", "null" ] } }, "required": [ "id", "key", "url", "title", "verified", "created_at", "read_only" ] } } } ], "previews": [], "descriptionHTML": "You can create a read-only deploy key.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "deploy-keys" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Get a deploy key", "category": "deploy-keys", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key_id", "description": "The unique identifier of the key.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "key_id": "KEY_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "key": "ssh-rsa AAA...", "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", "title": "octocat@octomac", "verified": true, "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", "last_used": "2022-01-10T15:53:42Z" }, "schema": { "title": "Deploy Key", "description": "An SSH key granting access to a single repository.", "type": "object", "properties": { "id": { "type": "integer" }, "key": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "verified": { "type": "boolean" }, "created_at": { "type": "string" }, "read_only": { "type": "boolean" }, "added_by": { "type": [ "string", "null" ] }, "last_used": { "type": [ "string", "null" ] } }, "required": [ "id", "key", "url", "title", "verified", "created_at", "read_only" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "deploy-keys" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Delete a deploy key", "category": "deploy-keys", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key_id", "description": "The unique identifier of the key.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "key_id": "KEY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "deploy-keys" } ] }, "deployments": { "deployments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", "subcategory": "deployments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sha", "description": "The SHA recorded at creation time.
", "in": "query", "required": false, "schema": { "type": "string", "default": "none" } }, { "name": "ref", "description": "The name of the ref. This can be a branch, tag, or SHA.
", "in": "query", "required": false, "schema": { "type": "string", "default": "none" } }, { "name": "task", "description": "The name of the task for the deployment (e.g., deploy or deploy:migrations).
The name of the environment that was deployed to (e.g., staging or production).
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, "node_id": "MDEwOkRlcGxveW1lbnQx", "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", "ref": "topic-branch", "task": "deploy", "payload": {}, "original_environment": "staging", "environment": "production", "description": "Deploy request from hubot", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", "repository_url": "https://api.github.com/repos/octocat/example", "transient_environment": false, "production_environment": true } ], "schema": { "type": "array", "items": { "title": "Deployment", "description": "A request for a specific ref(branch,sha,tag) to be deployed", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1" ] }, "id": { "description": "Unique identifier of the deployment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkRlcGxveW1lbnQx" ] }, "sha": { "type": "string", "examples": [ "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" ] }, "ref": { "description": "The ref to deploy. This can be a branch, tag, or sha.", "type": "string", "examples": [ "topic-branch" ] }, "task": { "description": "Parameter to specify a task to execute", "type": "string", "examples": [ "deploy" ] }, "payload": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" } ] }, "original_environment": { "type": "string", "examples": [ "staging" ] }, "environment": { "description": "Name for the target deployment environment.", "type": "string", "examples": [ "production" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Deploy request from hubot" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] }, "transient_environment": { "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", "type": "boolean", "examples": [ true ] }, "production_environment": { "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", "type": "boolean", "examples": [ true ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "sha", "ref", "task", "environment", "creator", "payload", "description", "statuses_url", "repository_url", "url", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Simple filtering of deployments is available via query parameters:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", "subcategory": "deployments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "ref", "in": "body", "description": "The ref to deploy. This can be a branch, tag, or SHA.
", "isRequired": true }, { "type": "string", "name": "task", "in": "body", "description": "Specifies a task to execute (e.g., deploy or deploy:migrations).
Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.
", "default": true }, { "type": "array of strings", "name": "required_contexts", "in": "body", "description": "The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.
" }, { "type": "object or string", "name": "payload", "in": "body", "description": "JSON payload with extra information about the deployment.
" }, { "type": "string", "name": "environment", "in": "body", "description": "Name for the target deployment environment (e.g., production, staging, qa).
Short description of the deployment.
" }, { "type": "boolean", "name": "transient_environment", "in": "body", "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false
Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.
Simple example
", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, "node_id": "MDEwOkRlcGxveW1lbnQx", "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", "ref": "topic-branch", "task": "deploy", "payload": {}, "original_environment": "staging", "environment": "production", "description": "Deploy request from hubot", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", "repository_url": "https://api.github.com/repos/octocat/example", "transient_environment": false, "production_environment": true }, "schema": { "title": "Deployment", "description": "A request for a specific ref(branch,sha,tag) to be deployed", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1" ] }, "id": { "description": "Unique identifier of the deployment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkRlcGxveW1lbnQx" ] }, "sha": { "type": "string", "examples": [ "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" ] }, "ref": { "description": "The ref to deploy. This can be a branch, tag, or sha.", "type": "string", "examples": [ "topic-branch" ] }, "task": { "description": "Parameter to specify a task to execute", "type": "string", "examples": [ "deploy" ] }, "payload": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" } ] }, "original_environment": { "type": "string", "examples": [ "staging" ] }, "environment": { "description": "Name for the target deployment environment.", "type": "string", "examples": [ "production" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Deploy request from hubot" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] }, "transient_environment": { "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", "type": "boolean", "examples": [ true ] }, "production_environment": { "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", "type": "boolean", "examples": [ true ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "sha", "ref", "task", "environment", "creator", "payload", "description", "statuses_url", "repository_url", "url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Deployments offer a few configurable parameters with certain defaults.
\nThe ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.
The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.
The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.
By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.
The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.
The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.
Users with repo or repo_deployment scopes can create a deployment for a given ref.
Merged branch response
\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:
\n- \n
- Auto-merge option is enabled in the repository \n
- Topic branch does not include the latest changes on the base branch, which is
masterin the response example \n - There are no merge conflicts \n
If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\nMerge conflict response
\nThis error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.
Failed commit status checks
\nThis error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.
Created
" }, { "httpStatusCode": "202", "description": "Merged branch response
" }, { "httpStatusCode": "409", "description": "Conflict when there is a merge conflict or the commit's status checks failed
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", "subcategory": "deployments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deployment_id", "description": "deployment_id parameter
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "deployment_id": "DEPLOYMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, "node_id": "MDEwOkRlcGxveW1lbnQx", "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", "ref": "topic-branch", "task": "deploy", "payload": {}, "original_environment": "staging", "environment": "production", "description": "Deploy request from hubot", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", "repository_url": "https://api.github.com/repos/octocat/example", "transient_environment": false, "production_environment": true }, "schema": { "title": "Deployment", "description": "A request for a specific ref(branch,sha,tag) to be deployed", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1" ] }, "id": { "description": "Unique identifier of the deployment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOkRlcGxveW1lbnQx" ] }, "sha": { "type": "string", "examples": [ "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" ] }, "ref": { "description": "The ref to deploy. This can be a branch, tag, or sha.", "type": "string", "examples": [ "topic-branch" ] }, "task": { "description": "Parameter to specify a task to execute", "type": "string", "examples": [ "deploy" ] }, "payload": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" } ] }, "original_environment": { "type": "string", "examples": [ "staging" ] }, "environment": { "description": "Name for the target deployment environment.", "type": "string", "examples": [ "production" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Deploy request from hubot" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] }, "transient_environment": { "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", "type": "boolean", "examples": [ true ] }, "production_environment": { "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", "type": "boolean", "examples": [ true ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "sha", "ref", "task", "environment", "creator", "payload", "description", "statuses_url", "repository_url", "url", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", "subcategory": "deployments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deployment_id", "description": "deployment_id parameter
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "deployment_id": "DEPLOYMENT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with repo or repo_deployment scopes can delete a deployment.
To set a deployment as inactive, you must:
\n- \n
- Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. \n
- Mark the active deployment as inactive by adding any non-successful deployment status. \n
For more information, see \"Create a deployment\" and \"Create a deployment status.\"
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "branch-policies": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", "title": "List deployment branch policies", "category": "deployments", "subcategory": "branch-policies", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "environment_name", "in": "path", "required": true, "description": "The name of the environment.
", "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "environment_name": "ENVIRONMENT_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "branch_policies": [ { "id": 361471, "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=", "name": "release/*" }, { "id": 361472, "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=", "name": "main" } ] }, "schema": { "type": "object", "properties": { "total_count": { "description": "The number of deployment branch policies for the environment.", "type": "integer", "examples": [ 2 ] }, "branch_policies": { "type": "array", "items": { "title": "Deployment branch policy", "description": "Details of a deployment branch policy.", "type": "object", "properties": { "id": { "description": "The unique identifier of the branch policy.", "type": "integer", "examples": [ 361471 ] }, "node_id": { "type": "string", "examples": [ "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=" ] }, "name": { "description": "The name pattern that branches must match in order to deploy to the environment.", "type": "string", "examples": [ "release/*" ] } } } } }, "required": [ "total_count", "branch_policies" ] } } } ], "previews": [], "descriptionHTML": "Lists the deployment branch policies for an environment.
\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", "title": "Create a deployment branch policy", "category": "deployments", "subcategory": "branch-policies", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "environment_name", "in": "path", "required": true, "description": "The name of the environment.
", "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name pattern that branches must match in order to deploy to the environment.
\nWildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.
Response
", "example": { "id": 364662, "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=", "name": "release/*" }, "schema": { "title": "Deployment branch policy", "description": "Details of a deployment branch policy.", "type": "object", "properties": { "id": { "description": "The unique identifier of the branch policy.", "type": "integer", "examples": [ 361471 ] }, "node_id": { "type": "string", "examples": [ "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=" ] }, "name": { "description": "The name pattern that branches must match in order to deploy to the environment.", "type": "string", "examples": [ "release/*" ] } } } }, "request": { "contentType": "application/json", "description": "Example of a wildcard name pattern", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "release/*" }, "parameters": { "owner": "OWNER", "repo": "REPO", "environment_name": "ENVIRONMENT_NAME" } } }, { "key": "example-single-branch", "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 364663, "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=", "name": "main" }, "schema": { "title": "Deployment branch policy", "description": "Details of a deployment branch policy.", "type": "object", "properties": { "id": { "description": "The unique identifier of the branch policy.", "type": "integer", "examples": [ 361471 ] }, "node_id": { "type": "string", "examples": [ "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=" ] }, "name": { "description": "The name pattern that branches must match in order to deploy to the environment.", "type": "string", "examples": [ "release/*" ] } } } }, "request": { "contentType": "application/json", "description": "Example of a single branch name pattern", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "main" }, "parameters": { "owner": "OWNER", "repo": "REPO", "environment_name": "ENVIRONMENT_NAME" } } } ], "previews": [], "descriptionHTML": "Creates a deployment branch policy for an environment.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration:write permission for the repository to use this endpoint.
OK
" }, { "httpStatusCode": "303", "description": "Response if the same branch name pattern already exists
" }, { "httpStatusCode": "404", "description": "Not Found or deployment_branch_policy.custom_branch_policies property for the environment is set to false
The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "environment_name", "in": "path", "required": true, "description": "The name of the environment.
", "schema": { "type": "string" } }, { "name": "branch_policy_id", "in": "path", "required": true, "description": "The unique identifier of the branch policy.
", "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "environment_name": "ENVIRONMENT_NAME", "branch_policy_id": "BRANCH_POLICY_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 364662, "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=", "name": "release/*" }, "schema": { "title": "Deployment branch policy", "description": "Details of a deployment branch policy.", "type": "object", "properties": { "id": { "description": "The unique identifier of the branch policy.", "type": "integer", "examples": [ 361471 ] }, "node_id": { "type": "string", "examples": [ "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=" ] }, "name": { "description": "The name pattern that branches must match in order to deploy to the environment.", "type": "string", "examples": [ "release/*" ] } } } } } ], "previews": [], "descriptionHTML": "Gets a deployment branch policy for an environment.
\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", "title": "Update a deployment branch policy", "category": "deployments", "subcategory": "branch-policies", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "environment_name", "in": "path", "required": true, "description": "The name of the environment.
", "schema": { "type": "string" } }, { "name": "branch_policy_id", "in": "path", "required": true, "description": "The unique identifier of the branch policy.
", "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name pattern that branches must match in order to deploy to the environment.
\nWildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.
Response
", "example": { "id": 364662, "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=", "name": "release/*" }, "schema": { "title": "Deployment branch policy", "description": "Details of a deployment branch policy.", "type": "object", "properties": { "id": { "description": "The unique identifier of the branch policy.", "type": "integer", "examples": [ 361471 ] }, "node_id": { "type": "string", "examples": [ "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=" ] }, "name": { "description": "The name pattern that branches must match in order to deploy to the environment.", "type": "string", "examples": [ "release/*" ] } } } } } ], "previews": [], "descriptionHTML": "Updates a deployment branch policy for an environment.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration:write permission for the repository to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", "title": "Delete a deployment branch policy", "category": "deployments", "subcategory": "branch-policies", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "environment_name", "in": "path", "required": true, "description": "The name of the environment.
", "schema": { "type": "string" } }, { "name": "branch_policy_id", "in": "path", "required": true, "description": "The unique identifier of the branch policy.
", "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "environment_name": "ENVIRONMENT_NAME", "branch_policy_id": "BRANCH_POLICY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a deployment branch policy for an environment.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration:write permission for the repository to use this endpoint.
No Content
" } ] } ], "environments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/environments", "title": "List environments", "category": "deployments", "subcategory": "environments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "environments": [ { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", "name": "staging", "url": "https://api.github.com/repos/github/hello-world/environments/staging", "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", "created_at": "2020-11-23T22:00:40Z", "updated_at": "2020-11-23T22:00:40Z", "protection_rules": [ { "id": 3736, "node_id": "MDQ6R2F0ZTM3MzY=", "type": "wait_timer", "wait_timer": 30 }, { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", "type": "required_reviewers", "reviewers": [ { "type": "User", "reviewer": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, { "type": "Team", "reviewer": { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } } ] }, { "id": 3756, "node_id": "MDQ6R2F0ZTM3NTY=", "type": "branch_policy" } ], "deployment_branch_policy": { "protected_branches": false, "custom_branch_policies": true } } ] }, "schema": { "type": "object", "properties": { "total_count": { "description": "The number of environments in this repository", "type": "integer", "examples": [ 5 ] }, "environments": { "type": "array", "items": { "title": "Environment", "description": "Details of a deployment environment", "type": "object", "properties": { "id": { "description": "The id of the environment.", "type": "integer", "examples": [ 56780428 ] }, "node_id": { "type": "string", "examples": [ "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" ] }, "name": { "description": "The name of the environment.", "type": "string", "examples": [ "staging" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/environments/staging" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" ] }, "created_at": { "description": "The time that the environment was created, in ISO 8601 format.", "format": "date-time", "type": "string", "examples": [ "2020-11-23T22:00:40Z" ] }, "updated_at": { "description": "The time that the environment was last updated, in ISO 8601 format.", "format": "date-time", "type": "string", "examples": [ "2020-11-23T22:00:40Z" ] }, "protection_rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 3515 ] }, "node_id": { "type": "string", "examples": [ "MDQ6R2F0ZTM1MTU=" ] }, "type": { "type": "string", "examples": [ "wait_timer" ] }, "wait_timer": { "type": "integer", "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", "examples": [ 30 ] } }, "required": [ "id", "node_id", "type" ] }, { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 3755 ] }, "node_id": { "type": "string", "examples": [ "MDQ6R2F0ZTM3NTU=" ] }, "type": { "type": "string", "examples": [ "required_reviewers" ] }, "reviewers": { "type": "array", "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of reviewer.", "enum": [ "User", "Team" ], "examples": [ "User" ] }, "reviewer": { "anyOf": [ { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } ] } } } } }, "required": [ "id", "node_id", "type" ] }, { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 3515 ] }, "node_id": { "type": "string", "examples": [ "MDQ6R2F0ZTM1MTU=" ] }, "type": { "type": "string", "examples": [ "branch_policy" ] } }, "required": [ "id", "node_id", "type" ] } ] } }, "deployment_branch_policy": { "type": [ "object", "null" ], "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", "properties": { "protected_branches": { "type": "boolean", "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." }, "custom_branch_policies": { "type": "boolean", "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." } }, "required": [ "protected_branches", "custom_branch_policies" ] } }, "required": [ "id", "node_id", "name", "url", "html_url", "created_at", "updated_at" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists the environments for a repository.
\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", "title": "Get an environment", "category": "deployments", "subcategory": "environments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "environment_name", "in": "path", "required": true, "description": "The name of the environment.
", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "environment_name": "ENVIRONMENT_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", "name": "staging", "url": "https://api.github.com/repos/github/hello-world/environments/staging", "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", "created_at": "2020-11-23T22:00:40Z", "updated_at": "2020-11-23T22:00:40Z", "protection_rules": [ { "id": 3736, "node_id": "MDQ6R2F0ZTM3MzY=", "type": "wait_timer", "wait_timer": 30 }, { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", "type": "required_reviewers", "reviewers": [ { "type": "User", "reviewer": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, { "type": "Team", "reviewer": { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } } ] }, { "id": 3756, "node_id": "MDQ6R2F0ZTM3NTY=", "type": "branch_policy" } ], "deployment_branch_policy": { "protected_branches": false, "custom_branch_policies": true } }, "schema": { "title": "Environment", "description": "Details of a deployment environment", "type": "object", "properties": { "id": { "description": "The id of the environment.", "type": "integer", "examples": [ 56780428 ] }, "node_id": { "type": "string", "examples": [ "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" ] }, "name": { "description": "The name of the environment.", "type": "string", "examples": [ "staging" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/environments/staging" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" ] }, "created_at": { "description": "The time that the environment was created, in ISO 8601 format.", "format": "date-time", "type": "string", "examples": [ "2020-11-23T22:00:40Z" ] }, "updated_at": { "description": "The time that the environment was last updated, in ISO 8601 format.", "format": "date-time", "type": "string", "examples": [ "2020-11-23T22:00:40Z" ] }, "protection_rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 3515 ] }, "node_id": { "type": "string", "examples": [ "MDQ6R2F0ZTM1MTU=" ] }, "type": { "type": "string", "examples": [ "wait_timer" ] }, "wait_timer": { "type": "integer", "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", "examples": [ 30 ] } }, "required": [ "id", "node_id", "type" ] }, { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 3755 ] }, "node_id": { "type": "string", "examples": [ "MDQ6R2F0ZTM3NTU=" ] }, "type": { "type": "string", "examples": [ "required_reviewers" ] }, "reviewers": { "type": "array", "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of reviewer.", "enum": [ "User", "Team" ], "examples": [ "User" ] }, "reviewer": { "anyOf": [ { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } ] } } } } }, "required": [ "id", "node_id", "type" ] }, { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 3515 ] }, "node_id": { "type": "string", "examples": [ "MDQ6R2F0ZTM1MTU=" ] }, "type": { "type": "string", "examples": [ "branch_policy" ] } }, "required": [ "id", "node_id", "type" ] } ] } }, "deployment_branch_policy": { "type": [ "object", "null" ], "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", "properties": { "protected_branches": { "type": "boolean", "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." }, "custom_branch_policies": { "type": "boolean", "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." } }, "required": [ "protected_branches", "custom_branch_policies" ] } }, "required": [ "id", "node_id", "name", "url", "html_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Note: To get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint. If the\nrepository is private, you must use an access token with the repo scope. GitHub\nApps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", "title": "Create or update an environment", "category": "deployments", "subcategory": "environments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "environment_name", "in": "path", "required": true, "description": "The name of the environment.
", "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "integer", "name": "wait_timer", "in": "body", "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
" }, { "type": "array of objects or null", "name": "reviewers", "in": "body", "description": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.
", "childParamsGroups": [ { "type": "string", "name": "type", "description": "The type of reviewer.
", "enum": [ "User", "Team" ] }, { "type": "integer", "name": "id", "description": "The id of the user or team who can review the deployment
" } ] }, { "type": "object or null", "name": "deployment_branch_policy", "in": "body", "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.
Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.
Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.
Response
", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", "name": "staging", "url": "https://api.github.com/repos/github/hello-world/environments/staging", "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", "created_at": "2020-11-23T22:00:40Z", "updated_at": "2020-11-23T22:00:40Z", "protection_rules": [ { "id": 3736, "node_id": "MDQ6R2F0ZTM3MzY=", "type": "wait_timer", "wait_timer": 30 }, { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", "type": "required_reviewers", "reviewers": [ { "type": "User", "reviewer": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, { "type": "Team", "reviewer": { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } } ] }, { "id": 3756, "node_id": "MDQ6R2F0ZTM3NTY=", "type": "branch_policy" } ], "deployment_branch_policy": { "protected_branches": false, "custom_branch_policies": true } }, "schema": { "title": "Environment", "description": "Details of a deployment environment", "type": "object", "properties": { "id": { "description": "The id of the environment.", "type": "integer", "examples": [ 56780428 ] }, "node_id": { "type": "string", "examples": [ "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" ] }, "name": { "description": "The name of the environment.", "type": "string", "examples": [ "staging" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/environments/staging" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" ] }, "created_at": { "description": "The time that the environment was created, in ISO 8601 format.", "format": "date-time", "type": "string", "examples": [ "2020-11-23T22:00:40Z" ] }, "updated_at": { "description": "The time that the environment was last updated, in ISO 8601 format.", "format": "date-time", "type": "string", "examples": [ "2020-11-23T22:00:40Z" ] }, "protection_rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 3515 ] }, "node_id": { "type": "string", "examples": [ "MDQ6R2F0ZTM1MTU=" ] }, "type": { "type": "string", "examples": [ "wait_timer" ] }, "wait_timer": { "type": "integer", "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", "examples": [ 30 ] } }, "required": [ "id", "node_id", "type" ] }, { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 3755 ] }, "node_id": { "type": "string", "examples": [ "MDQ6R2F0ZTM3NTU=" ] }, "type": { "type": "string", "examples": [ "required_reviewers" ] }, "reviewers": { "type": "array", "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of reviewer.", "enum": [ "User", "Team" ], "examples": [ "User" ] }, "reviewer": { "anyOf": [ { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } ] } } } } }, "required": [ "id", "node_id", "type" ] }, { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 3515 ] }, "node_id": { "type": "string", "examples": [ "MDQ6R2F0ZTM1MTU=" ] }, "type": { "type": "string", "examples": [ "branch_policy" ] } }, "required": [ "id", "node_id", "type" ] } ] } }, "deployment_branch_policy": { "type": [ "object", "null" ], "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", "properties": { "protected_branches": { "type": "boolean", "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." }, "custom_branch_policies": { "type": "boolean", "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." } }, "required": [ "protected_branches", "custom_branch_policies" ] } }, "required": [ "id", "node_id", "name", "url", "html_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote: To create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote: To create or update secrets for an environment, see \"Secrets.\"
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration:write permission for the repository to use this endpoint.
OK
" }, { "httpStatusCode": "422", "description": "Validation error when the environment name is invalid or when protected_branches and custom_branch_policies in deployment_branch_policy are set to the same value
The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "environment_name", "in": "path", "required": true, "description": "The name of the environment.
", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "environment_name": "ENVIRONMENT_NAME" } }, "response": { "statusCode": "204", "description": "Default response
" } } ], "previews": [], "descriptionHTML": "You must authenticate using an access token with the repo scope to use this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", "description": "Default response
" } ] } ], "statuses": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "title": "List deployment statuses", "category": "deployments", "subcategory": "statuses", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deployment_id", "description": "deployment_id parameter
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "deployment_id": "DEPLOYMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx", "state": "success", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "description": "Deployment finished successfully.", "environment": "production", "target_url": "https://example.com/deployment/42/output", "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42", "repository_url": "https://api.github.com/repos/octocat/example", "environment_url": "https://test-branch.lab.acme.com", "log_url": "https://example.com/deployment/42/output" } ], "schema": { "type": "array", "items": { "title": "Deployment Status", "description": "The status of a deployment.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/42/statuses/1" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDE2OkRlcGxveW1lbnRTdGF0dXMx" ] }, "state": { "description": "The state of the status.", "enum": [ "error", "failure", "inactive", "pending", "success", "queued", "in_progress" ], "type": "string", "examples": [ "success" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "description": { "description": "A short description of the status.", "default": "", "type": "string", "maxLength": 140, "examples": [ "Deployment finished successfully." ] }, "environment": { "description": "The environment of the deployment that the status is for.", "default": "", "type": "string", "examples": [ "production" ] }, "target_url": { "description": "Deprecated: the URL to associate with this status.", "default": "", "type": "string", "format": "uri", "examples": [ "https://example.com/deployment/42/output" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "deployment_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/42" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] }, "environment_url": { "description": "The URL for accessing your environment.", "default": "", "type": "string", "format": "uri", "examples": [ "https://staging.example.com/" ] }, "log_url": { "description": "The URL to associate with this status.", "default": "", "type": "string", "format": "uri", "examples": [ "https://example.com/deployment/42/output" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "state", "creator", "description", "deployment_url", "target_url", "repository_url", "url", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Users with pull access can view deployment statuses for a deployment:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "title": "Create a deployment status", "category": "deployments", "subcategory": "statuses", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deployment_id", "description": "deployment_id parameter
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "state", "in": "body", "description": "The state of the status. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.
The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"
A short description of the status. The maximum description length is 140 characters.
" }, { "type": "string", "name": "environment", "in": "body", "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa.
Sets the URL for accessing your environment. Default: \"\"
Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true
Response
", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx", "state": "success", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "description": "Deployment finished successfully.", "environment": "production", "target_url": "https://example.com/deployment/42/output", "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42", "repository_url": "https://api.github.com/repos/octocat/example", "environment_url": "https://test-branch.lab.acme.com", "log_url": "https://example.com/deployment/42/output" }, "schema": { "title": "Deployment Status", "description": "The status of a deployment.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/42/statuses/1" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDE2OkRlcGxveW1lbnRTdGF0dXMx" ] }, "state": { "description": "The state of the status.", "enum": [ "error", "failure", "inactive", "pending", "success", "queued", "in_progress" ], "type": "string", "examples": [ "success" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "description": { "description": "A short description of the status.", "default": "", "type": "string", "maxLength": 140, "examples": [ "Deployment finished successfully." ] }, "environment": { "description": "The environment of the deployment that the status is for.", "default": "", "type": "string", "examples": [ "production" ] }, "target_url": { "description": "Deprecated: the URL to associate with this status.", "default": "", "type": "string", "format": "uri", "examples": [ "https://example.com/deployment/42/output" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "deployment_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/42" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] }, "environment_url": { "description": "The URL for accessing your environment.", "default": "", "type": "string", "format": "uri", "examples": [ "https://staging.example.com/" ] }, "log_url": { "description": "The URL to associate with this status.", "default": "", "type": "string", "format": "uri", "examples": [ "https://example.com/deployment/42/output" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "state", "creator", "description", "deployment_url", "target_url", "repository_url", "url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Users with push access can create deployment statuses for a given deployment.
GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.
Created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", "title": "Get a deployment status", "category": "deployments", "subcategory": "statuses", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deployment_id", "description": "deployment_id parameter
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "status_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "deployment_id": "DEPLOYMENT_ID", "status_id": "STATUS_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx", "state": "success", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "description": "Deployment finished successfully.", "environment": "production", "target_url": "https://example.com/deployment/42/output", "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42", "repository_url": "https://api.github.com/repos/octocat/example", "environment_url": "https://test-branch.lab.acme.com", "log_url": "https://example.com/deployment/42/output" }, "schema": { "title": "Deployment Status", "description": "The status of a deployment.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/42/statuses/1" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDE2OkRlcGxveW1lbnRTdGF0dXMx" ] }, "state": { "description": "The state of the status.", "enum": [ "error", "failure", "inactive", "pending", "success", "queued", "in_progress" ], "type": "string", "examples": [ "success" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "description": { "description": "A short description of the status.", "default": "", "type": "string", "maxLength": 140, "examples": [ "Deployment finished successfully." ] }, "environment": { "description": "The environment of the deployment that the status is for.", "default": "", "type": "string", "examples": [ "production" ] }, "target_url": { "description": "Deprecated: the URL to associate with this status.", "default": "", "type": "string", "format": "uri", "examples": [ "https://example.com/deployment/42/output" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2012-07-20T01:19:13Z" ] }, "deployment_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/42" ] }, "repository_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example" ] }, "environment_url": { "description": "The URL for accessing your environment.", "default": "", "type": "string", "format": "uri", "examples": [ "https://staging.example.com/" ] }, "log_url": { "description": "The URL to associate with this status.", "default": "", "type": "string", "format": "uri", "examples": [ "https://example.com/deployment/42/output" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "state", "creator", "description", "deployment_url", "target_url", "repository_url", "url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Users with pull access can view a deployment status for a deployment:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ] }, "emojis": { "emojis": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/emojis", "title": "Get emojis", "category": "emojis", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "100": "https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8", "1234": "https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8", "+1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8", "-1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8", "1st_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8", "2nd_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8", "3rd_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8", "8ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8", "a": "https://github.githubassets.com/images/icons/emoji/unicode/1f170.png?v8", "ab": "https://github.githubassets.com/images/icons/emoji/unicode/1f18e.png?v8", "abacus": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ee.png?v8", "abc": "https://github.githubassets.com/images/icons/emoji/unicode/1f524.png?v8", "abcd": "https://github.githubassets.com/images/icons/emoji/unicode/1f521.png?v8", "accept": "https://github.githubassets.com/images/icons/emoji/unicode/1f251.png?v8", "accordion": "https://github.githubassets.com/images/icons/emoji/unicode/1fa97.png?v8", "adhesive_bandage": "https://github.githubassets.com/images/icons/emoji/unicode/1fa79.png?v8", "adult": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1.png?v8", "aerial_tramway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a1.png?v8", "afghanistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1eb.png?v8", "airplane": "https://github.githubassets.com/images/icons/emoji/unicode/2708.png?v8", "aland_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fd.png?v8", "alarm_clock": "https://github.githubassets.com/images/icons/emoji/unicode/23f0.png?v8", "albania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f1.png?v8", "alembic": "https://github.githubassets.com/images/icons/emoji/unicode/2697.png?v8", "algeria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ff.png?v8", "alien": "https://github.githubassets.com/images/icons/emoji/unicode/1f47d.png?v8", "ambulance": "https://github.githubassets.com/images/icons/emoji/unicode/1f691.png?v8", "american_samoa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f8.png?v8", "amphora": "https://github.githubassets.com/images/icons/emoji/unicode/1f3fa.png?v8", "anatomical_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1fac0.png?v8", "anchor": "https://github.githubassets.com/images/icons/emoji/unicode/2693.png?v8", "andorra": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e9.png?v8", "angel": "https://github.githubassets.com/images/icons/emoji/unicode/1f47c.png?v8", "anger": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a2.png?v8", "angola": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f4.png?v8", "angry": "https://github.githubassets.com/images/icons/emoji/unicode/1f620.png?v8", "anguilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ee.png?v8", "anguished": "https://github.githubassets.com/images/icons/emoji/unicode/1f627.png?v8", "ant": "https://github.githubassets.com/images/icons/emoji/unicode/1f41c.png?v8", "antarctica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f6.png?v8", "antigua_barbuda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ec.png?v8", "apple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34e.png?v8", "aquarius": "https://github.githubassets.com/images/icons/emoji/unicode/2652.png?v8", "argentina": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f7.png?v8", "aries": "https://github.githubassets.com/images/icons/emoji/unicode/2648.png?v8", "armenia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f2.png?v8", "arrow_backward": "https://github.githubassets.com/images/icons/emoji/unicode/25c0.png?v8", "arrow_double_down": "https://github.githubassets.com/images/icons/emoji/unicode/23ec.png?v8", "arrow_double_up": "https://github.githubassets.com/images/icons/emoji/unicode/23eb.png?v8", "arrow_down": "https://github.githubassets.com/images/icons/emoji/unicode/2b07.png?v8", "arrow_down_small": "https://github.githubassets.com/images/icons/emoji/unicode/1f53d.png?v8", "arrow_forward": "https://github.githubassets.com/images/icons/emoji/unicode/25b6.png?v8", "arrow_heading_down": "https://github.githubassets.com/images/icons/emoji/unicode/2935.png?v8", "arrow_heading_up": "https://github.githubassets.com/images/icons/emoji/unicode/2934.png?v8", "arrow_left": "https://github.githubassets.com/images/icons/emoji/unicode/2b05.png?v8", "arrow_lower_left": "https://github.githubassets.com/images/icons/emoji/unicode/2199.png?v8", "arrow_lower_right": "https://github.githubassets.com/images/icons/emoji/unicode/2198.png?v8", "arrow_right": "https://github.githubassets.com/images/icons/emoji/unicode/27a1.png?v8", "arrow_right_hook": "https://github.githubassets.com/images/icons/emoji/unicode/21aa.png?v8", "arrow_up": "https://github.githubassets.com/images/icons/emoji/unicode/2b06.png?v8", "arrow_up_down": "https://github.githubassets.com/images/icons/emoji/unicode/2195.png?v8", "arrow_up_small": "https://github.githubassets.com/images/icons/emoji/unicode/1f53c.png?v8", "arrow_upper_left": "https://github.githubassets.com/images/icons/emoji/unicode/2196.png?v8", "arrow_upper_right": "https://github.githubassets.com/images/icons/emoji/unicode/2197.png?v8", "arrows_clockwise": "https://github.githubassets.com/images/icons/emoji/unicode/1f503.png?v8", "arrows_counterclockwise": "https://github.githubassets.com/images/icons/emoji/unicode/1f504.png?v8", "art": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a8.png?v8", "articulated_lorry": "https://github.githubassets.com/images/icons/emoji/unicode/1f69b.png?v8", "artificial_satellite": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f0.png?v8", "artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a8.png?v8", "aruba": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fc.png?v8", "ascension_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e8.png?v8", "asterisk": "https://github.githubassets.com/images/icons/emoji/unicode/002a-20e3.png?v8", "astonished": "https://github.githubassets.com/images/icons/emoji/unicode/1f632.png?v8", "astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f680.png?v8", "athletic_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45f.png?v8", "atm": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e7.png?v8", "atom": "https://github.githubassets.com/images/icons/emoji/atom.png?v8", "atom_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/269b.png?v8", "australia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fa.png?v8", "austria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f9.png?v8", "auto_rickshaw": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fa.png?v8", "avocado": "https://github.githubassets.com/images/icons/emoji/unicode/1f951.png?v8", "axe": "https://github.githubassets.com/images/icons/emoji/unicode/1fa93.png?v8", "azerbaijan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ff.png?v8", "b": "https://github.githubassets.com/images/icons/emoji/unicode/1f171.png?v8", "baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f476.png?v8", "baby_bottle": "https://github.githubassets.com/images/icons/emoji/unicode/1f37c.png?v8", "baby_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f424.png?v8", "baby_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bc.png?v8", "back": "https://github.githubassets.com/images/icons/emoji/unicode/1f519.png?v8", "bacon": "https://github.githubassets.com/images/icons/emoji/unicode/1f953.png?v8", "badger": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a1.png?v8", "badminton": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f8.png?v8", "bagel": "https://github.githubassets.com/images/icons/emoji/unicode/1f96f.png?v8", "baggage_claim": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c4.png?v8", "baguette_bread": "https://github.githubassets.com/images/icons/emoji/unicode/1f956.png?v8", "bahamas": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f8.png?v8", "bahrain": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ed.png?v8", "balance_scale": "https://github.githubassets.com/images/icons/emoji/unicode/2696.png?v8", "bald_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b2.png?v8", "bald_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b2.png?v8", "ballet_shoes": "https://github.githubassets.com/images/icons/emoji/unicode/1fa70.png?v8", "balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f388.png?v8", "ballot_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f5f3.png?v8", "ballot_box_with_check": "https://github.githubassets.com/images/icons/emoji/unicode/2611.png?v8", "bamboo": "https://github.githubassets.com/images/icons/emoji/unicode/1f38d.png?v8", "banana": "https://github.githubassets.com/images/icons/emoji/unicode/1f34c.png?v8", "bangbang": "https://github.githubassets.com/images/icons/emoji/unicode/203c.png?v8", "bangladesh": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e9.png?v8", "banjo": "https://github.githubassets.com/images/icons/emoji/unicode/1fa95.png?v8", "bank": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e6.png?v8", "bar_chart": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ca.png?v8", "barbados": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e7.png?v8", "barber": "https://github.githubassets.com/images/icons/emoji/unicode/1f488.png?v8", "baseball": "https://github.githubassets.com/images/icons/emoji/unicode/26be.png?v8", "basecamp": "https://github.githubassets.com/images/icons/emoji/basecamp.png?v8", "basecampy": "https://github.githubassets.com/images/icons/emoji/basecampy.png?v8", "basket": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fa.png?v8", "basketball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c0.png?v8", "basketball_man": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8", "basketball_woman": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8", "bat": "https://github.githubassets.com/images/icons/emoji/unicode/1f987.png?v8", "bath": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c0.png?v8", "bathtub": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c1.png?v8", "battery": "https://github.githubassets.com/images/icons/emoji/unicode/1f50b.png?v8", "beach_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d6.png?v8", "bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f43b.png?v8", "bearded_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4.png?v8", "beaver": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ab.png?v8", "bed": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cf.png?v8", "bee": "https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8", "beer": "https://github.githubassets.com/images/icons/emoji/unicode/1f37a.png?v8", "beers": "https://github.githubassets.com/images/icons/emoji/unicode/1f37b.png?v8", "beetle": "https://github.githubassets.com/images/icons/emoji/unicode/1fab2.png?v8", "beginner": "https://github.githubassets.com/images/icons/emoji/unicode/1f530.png?v8", "belarus": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fe.png?v8", "belgium": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ea.png?v8", "belize": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ff.png?v8", "bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f514.png?v8", "bell_pepper": "https://github.githubassets.com/images/icons/emoji/unicode/1fad1.png?v8", "bellhop_bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ce.png?v8", "benin": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ef.png?v8", "bento": "https://github.githubassets.com/images/icons/emoji/unicode/1f371.png?v8", "bermuda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f2.png?v8", "beverage_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c3.png?v8", "bhutan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f9.png?v8", "bicyclist": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4.png?v8", "bike": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b2.png?v8", "biking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2642.png?v8", "biking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2640.png?v8", "bikini": "https://github.githubassets.com/images/icons/emoji/unicode/1f459.png?v8", "billed_cap": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e2.png?v8", "biohazard": "https://github.githubassets.com/images/icons/emoji/unicode/2623.png?v8", "bird": "https://github.githubassets.com/images/icons/emoji/unicode/1f426.png?v8", "birthday": "https://github.githubassets.com/images/icons/emoji/unicode/1f382.png?v8", "bison": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ac.png?v8", "black_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f408-2b1b.png?v8", "black_circle": "https://github.githubassets.com/images/icons/emoji/unicode/26ab.png?v8", "black_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4.png?v8", "black_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a4.png?v8", "black_joker": "https://github.githubassets.com/images/icons/emoji/unicode/1f0cf.png?v8", "black_large_square": "https://github.githubassets.com/images/icons/emoji/unicode/2b1b.png?v8", "black_medium_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fe.png?v8", "black_medium_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fc.png?v8", "black_nib": "https://github.githubassets.com/images/icons/emoji/unicode/2712.png?v8", "black_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25aa.png?v8", "black_square_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f532.png?v8", "blond_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2642.png?v8", "blond_haired_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f471.png?v8", "blond_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8", "blonde_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8", "blossom": "https://github.githubassets.com/images/icons/emoji/unicode/1f33c.png?v8", "blowfish": "https://github.githubassets.com/images/icons/emoji/unicode/1f421.png?v8", "blue_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d8.png?v8", "blue_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f699.png?v8", "blue_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f499.png?v8", "blue_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e6.png?v8", "blueberries": "https://github.githubassets.com/images/icons/emoji/unicode/1fad0.png?v8", "blush": "https://github.githubassets.com/images/icons/emoji/unicode/1f60a.png?v8", "boar": "https://github.githubassets.com/images/icons/emoji/unicode/1f417.png?v8", "boat": "https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8", "bolivia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f4.png?v8", "bomb": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a3.png?v8", "bone": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b4.png?v8", "book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8", "bookmark": "https://github.githubassets.com/images/icons/emoji/unicode/1f516.png?v8", "bookmark_tabs": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d1.png?v8", "books": "https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png?v8", "boom": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8", "boomerang": "https://github.githubassets.com/images/icons/emoji/unicode/1fa83.png?v8", "boot": "https://github.githubassets.com/images/icons/emoji/unicode/1f462.png?v8", "bosnia_herzegovina": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e6.png?v8", "botswana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fc.png?v8", "bouncing_ball_man": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8", "bouncing_ball_person": "https://github.githubassets.com/images/icons/emoji/unicode/26f9.png?v8", "bouncing_ball_woman": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8", "bouquet": "https://github.githubassets.com/images/icons/emoji/unicode/1f490.png?v8", "bouvet_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fb.png?v8", "bow": "https://github.githubassets.com/images/icons/emoji/unicode/1f647.png?v8", "bow_and_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f9.png?v8", "bowing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f647-2642.png?v8", "bowing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f647-2640.png?v8", "bowl_with_spoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f963.png?v8", "bowling": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b3.png?v8", "bowtie": "https://github.githubassets.com/images/icons/emoji/bowtie.png?v8", "boxing_glove": "https://github.githubassets.com/images/icons/emoji/unicode/1f94a.png?v8", "boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f466.png?v8", "brain": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e0.png?v8", "brazil": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f7.png?v8", "bread": "https://github.githubassets.com/images/icons/emoji/unicode/1f35e.png?v8", "breast_feeding": "https://github.githubassets.com/images/icons/emoji/unicode/1f931.png?v8", "bricks": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f1.png?v8", "bride_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8", "bridge_at_night": "https://github.githubassets.com/images/icons/emoji/unicode/1f309.png?v8", "briefcase": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bc.png?v8", "british_indian_ocean_territory": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f4.png?v8", "british_virgin_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ec.png?v8", "broccoli": "https://github.githubassets.com/images/icons/emoji/unicode/1f966.png?v8", "broken_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f494.png?v8", "broom": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f9.png?v8", "brown_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e4.png?v8", "brown_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f90e.png?v8", "brown_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7eb.png?v8", "brunei": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f3.png?v8", "bubble_tea": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cb.png?v8", "bucket": "https://github.githubassets.com/images/icons/emoji/unicode/1faa3.png?v8", "bug": "https://github.githubassets.com/images/icons/emoji/unicode/1f41b.png?v8", "building_construction": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png?v8", "bulb": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png?v8", "bulgaria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ec.png?v8", "bullettrain_front": "https://github.githubassets.com/images/icons/emoji/unicode/1f685.png?v8", "bullettrain_side": "https://github.githubassets.com/images/icons/emoji/unicode/1f684.png?v8", "burkina_faso": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1eb.png?v8", "burrito": "https://github.githubassets.com/images/icons/emoji/unicode/1f32f.png?v8", "burundi": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ee.png?v8", "bus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68c.png?v8", "business_suit_levitating": "https://github.githubassets.com/images/icons/emoji/unicode/1f574.png?v8", "busstop": "https://github.githubassets.com/images/icons/emoji/unicode/1f68f.png?v8", "bust_in_silhouette": "https://github.githubassets.com/images/icons/emoji/unicode/1f464.png?v8", "busts_in_silhouette": "https://github.githubassets.com/images/icons/emoji/unicode/1f465.png?v8", "butter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c8.png?v8", "butterfly": "https://github.githubassets.com/images/icons/emoji/unicode/1f98b.png?v8", "cactus": "https://github.githubassets.com/images/icons/emoji/unicode/1f335.png?v8", "cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f370.png?v8", "calendar": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c6.png?v8", "call_me_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f919.png?v8", "calling": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f2.png?v8", "cambodia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ed.png?v8", "camel": "https://github.githubassets.com/images/icons/emoji/unicode/1f42b.png?v8", "camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f7.png?v8", "camera_flash": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f8.png?v8", "cameroon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f2.png?v8", "camping": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d5.png?v8", "canada": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e6.png?v8", "canary_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e8.png?v8", "cancer": "https://github.githubassets.com/images/icons/emoji/unicode/264b.png?v8", "candle": "https://github.githubassets.com/images/icons/emoji/unicode/1f56f.png?v8", "candy": "https://github.githubassets.com/images/icons/emoji/unicode/1f36c.png?v8", "canned_food": "https://github.githubassets.com/images/icons/emoji/unicode/1f96b.png?v8", "canoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f6.png?v8", "cape_verde": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fb.png?v8", "capital_abcd": "https://github.githubassets.com/images/icons/emoji/unicode/1f520.png?v8", "capricorn": "https://github.githubassets.com/images/icons/emoji/unicode/2651.png?v8", "car": "https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8", "card_file_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c3.png?v8", "card_index": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c7.png?v8", "card_index_dividers": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c2.png?v8", "caribbean_netherlands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f6.png?v8", "carousel_horse": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a0.png?v8", "carpentry_saw": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9a.png?v8", "carrot": "https://github.githubassets.com/images/icons/emoji/unicode/1f955.png?v8", "cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938.png?v8", "cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f431.png?v8", "cat2": "https://github.githubassets.com/images/icons/emoji/unicode/1f408.png?v8", "cayman_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fe.png?v8", "cd": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bf.png?v8", "central_african_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1eb.png?v8", "ceuta_melilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e6.png?v8", "chad": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e9.png?v8", "chains": "https://github.githubassets.com/images/icons/emoji/unicode/26d3.png?v8", "chair": "https://github.githubassets.com/images/icons/emoji/unicode/1fa91.png?v8", "champagne": "https://github.githubassets.com/images/icons/emoji/unicode/1f37e.png?v8", "chart": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b9.png?v8", "chart_with_downwards_trend": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c9.png?v8", "chart_with_upwards_trend": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c8.png?v8", "checkered_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c1.png?v8", "cheese": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c0.png?v8", "cherries": "https://github.githubassets.com/images/icons/emoji/unicode/1f352.png?v8", "cherry_blossom": "https://github.githubassets.com/images/icons/emoji/unicode/1f338.png?v8", "chess_pawn": "https://github.githubassets.com/images/icons/emoji/unicode/265f.png?v8", "chestnut": "https://github.githubassets.com/images/icons/emoji/unicode/1f330.png?v8", "chicken": "https://github.githubassets.com/images/icons/emoji/unicode/1f414.png?v8", "child": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d2.png?v8", "children_crossing": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b8.png?v8", "chile": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f1.png?v8", "chipmunk": "https://github.githubassets.com/images/icons/emoji/unicode/1f43f.png?v8", "chocolate_bar": "https://github.githubassets.com/images/icons/emoji/unicode/1f36b.png?v8", "chopsticks": "https://github.githubassets.com/images/icons/emoji/unicode/1f962.png?v8", "christmas_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fd.png?v8", "christmas_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f384.png?v8", "church": "https://github.githubassets.com/images/icons/emoji/unicode/26ea.png?v8", "cinema": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a6.png?v8", "circus_tent": "https://github.githubassets.com/images/icons/emoji/unicode/1f3aa.png?v8", "city_sunrise": "https://github.githubassets.com/images/icons/emoji/unicode/1f307.png?v8", "city_sunset": "https://github.githubassets.com/images/icons/emoji/unicode/1f306.png?v8", "cityscape": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d9.png?v8", "cl": "https://github.githubassets.com/images/icons/emoji/unicode/1f191.png?v8", "clamp": "https://github.githubassets.com/images/icons/emoji/unicode/1f5dc.png?v8", "clap": "https://github.githubassets.com/images/icons/emoji/unicode/1f44f.png?v8", "clapper": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ac.png?v8", "classical_building": "https://github.githubassets.com/images/icons/emoji/unicode/1f3db.png?v8", "climbing": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7.png?v8", "climbing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2642.png?v8", "climbing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2640.png?v8", "clinking_glasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f942.png?v8", "clipboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cb.png?v8", "clipperton_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f5.png?v8", "clock1": "https://github.githubassets.com/images/icons/emoji/unicode/1f550.png?v8", "clock10": "https://github.githubassets.com/images/icons/emoji/unicode/1f559.png?v8", "clock1030": "https://github.githubassets.com/images/icons/emoji/unicode/1f565.png?v8", "clock11": "https://github.githubassets.com/images/icons/emoji/unicode/1f55a.png?v8", "clock1130": "https://github.githubassets.com/images/icons/emoji/unicode/1f566.png?v8", "clock12": "https://github.githubassets.com/images/icons/emoji/unicode/1f55b.png?v8", "clock1230": "https://github.githubassets.com/images/icons/emoji/unicode/1f567.png?v8", "clock130": "https://github.githubassets.com/images/icons/emoji/unicode/1f55c.png?v8", "clock2": "https://github.githubassets.com/images/icons/emoji/unicode/1f551.png?v8", "clock230": "https://github.githubassets.com/images/icons/emoji/unicode/1f55d.png?v8", "clock3": "https://github.githubassets.com/images/icons/emoji/unicode/1f552.png?v8", "clock330": "https://github.githubassets.com/images/icons/emoji/unicode/1f55e.png?v8", "clock4": "https://github.githubassets.com/images/icons/emoji/unicode/1f553.png?v8", "clock430": "https://github.githubassets.com/images/icons/emoji/unicode/1f55f.png?v8", "clock5": "https://github.githubassets.com/images/icons/emoji/unicode/1f554.png?v8", "clock530": "https://github.githubassets.com/images/icons/emoji/unicode/1f560.png?v8", "clock6": "https://github.githubassets.com/images/icons/emoji/unicode/1f555.png?v8", "clock630": "https://github.githubassets.com/images/icons/emoji/unicode/1f561.png?v8", "clock7": "https://github.githubassets.com/images/icons/emoji/unicode/1f556.png?v8", "clock730": "https://github.githubassets.com/images/icons/emoji/unicode/1f562.png?v8", "clock8": "https://github.githubassets.com/images/icons/emoji/unicode/1f557.png?v8", "clock830": "https://github.githubassets.com/images/icons/emoji/unicode/1f563.png?v8", "clock9": "https://github.githubassets.com/images/icons/emoji/unicode/1f558.png?v8", "clock930": "https://github.githubassets.com/images/icons/emoji/unicode/1f564.png?v8", "closed_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d5.png?v8", "closed_lock_with_key": "https://github.githubassets.com/images/icons/emoji/unicode/1f510.png?v8", "closed_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/1f302.png?v8", "cloud": "https://github.githubassets.com/images/icons/emoji/unicode/2601.png?v8", "cloud_with_lightning": "https://github.githubassets.com/images/icons/emoji/unicode/1f329.png?v8", "cloud_with_lightning_and_rain": "https://github.githubassets.com/images/icons/emoji/unicode/26c8.png?v8", "cloud_with_rain": "https://github.githubassets.com/images/icons/emoji/unicode/1f327.png?v8", "cloud_with_snow": "https://github.githubassets.com/images/icons/emoji/unicode/1f328.png?v8", "clown_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f921.png?v8", "clubs": "https://github.githubassets.com/images/icons/emoji/unicode/2663.png?v8", "cn": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f3.png?v8", "coat": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e5.png?v8", "cockroach": "https://github.githubassets.com/images/icons/emoji/unicode/1fab3.png?v8", "cocktail": "https://github.githubassets.com/images/icons/emoji/unicode/1f378.png?v8", "coconut": "https://github.githubassets.com/images/icons/emoji/unicode/1f965.png?v8", "cocos_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e8.png?v8", "coffee": "https://github.githubassets.com/images/icons/emoji/unicode/2615.png?v8", "coffin": "https://github.githubassets.com/images/icons/emoji/unicode/26b0.png?v8", "coin": "https://github.githubassets.com/images/icons/emoji/unicode/1fa99.png?v8", "cold_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f976.png?v8", "cold_sweat": "https://github.githubassets.com/images/icons/emoji/unicode/1f630.png?v8", "collision": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8", "colombia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f4.png?v8", "comet": "https://github.githubassets.com/images/icons/emoji/unicode/2604.png?v8", "comoros": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f2.png?v8", "compass": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ed.png?v8", "computer": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png?v8", "computer_mouse": "https://github.githubassets.com/images/icons/emoji/unicode/1f5b1.png?v8", "confetti_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f38a.png?v8", "confounded": "https://github.githubassets.com/images/icons/emoji/unicode/1f616.png?v8", "confused": "https://github.githubassets.com/images/icons/emoji/unicode/1f615.png?v8", "congo_brazzaville": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ec.png?v8", "congo_kinshasa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e9.png?v8", "congratulations": "https://github.githubassets.com/images/icons/emoji/unicode/3297.png?v8", "construction": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png?v8", "construction_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f477.png?v8", "construction_worker_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f477-2642.png?v8", "construction_worker_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f477-2640.png?v8", "control_knobs": "https://github.githubassets.com/images/icons/emoji/unicode/1f39b.png?v8", "convenience_store": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ea.png?v8", "cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f373.png?v8", "cook_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f0.png?v8", "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", "cote_divoire": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ee.png?v8", "couch_and_lamp": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cb.png?v8", "couple": "https://github.githubassets.com/images/icons/emoji/unicode/1f46b.png?v8", "couple_with_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f491.png?v8", "couple_with_heart_man_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f468.png?v8", "couple_with_heart_woman_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f468.png?v8", "couple_with_heart_woman_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f469.png?v8", "couplekiss": "https://github.githubassets.com/images/icons/emoji/unicode/1f48f.png?v8", "couplekiss_man_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f48b-1f468.png?v8", "couplekiss_man_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f468.png?v8", "couplekiss_woman_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f469.png?v8", "cow": "https://github.githubassets.com/images/icons/emoji/unicode/1f42e.png?v8", "cow2": "https://github.githubassets.com/images/icons/emoji/unicode/1f404.png?v8", "cowboy_hat_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f920.png?v8", "crab": "https://github.githubassets.com/images/icons/emoji/unicode/1f980.png?v8", "crayon": "https://github.githubassets.com/images/icons/emoji/unicode/1f58d.png?v8", "credit_card": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b3.png?v8", "crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f319.png?v8", "cricket": "https://github.githubassets.com/images/icons/emoji/unicode/1f997.png?v8", "cricket_game": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cf.png?v8", "croatia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f7.png?v8", "crocodile": "https://github.githubassets.com/images/icons/emoji/unicode/1f40a.png?v8", "croissant": "https://github.githubassets.com/images/icons/emoji/unicode/1f950.png?v8", "crossed_fingers": "https://github.githubassets.com/images/icons/emoji/unicode/1f91e.png?v8", "crossed_flags": "https://github.githubassets.com/images/icons/emoji/unicode/1f38c.png?v8", "crossed_swords": "https://github.githubassets.com/images/icons/emoji/unicode/2694.png?v8", "crown": "https://github.githubassets.com/images/icons/emoji/unicode/1f451.png?v8", "cry": "https://github.githubassets.com/images/icons/emoji/unicode/1f622.png?v8", "crying_cat_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f63f.png?v8", "crystal_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f52e.png?v8", "cuba": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fa.png?v8", "cucumber": "https://github.githubassets.com/images/icons/emoji/unicode/1f952.png?v8", "cup_with_straw": "https://github.githubassets.com/images/icons/emoji/unicode/1f964.png?v8", "cupcake": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c1.png?v8", "cupid": "https://github.githubassets.com/images/icons/emoji/unicode/1f498.png?v8", "curacao": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fc.png?v8", "curling_stone": "https://github.githubassets.com/images/icons/emoji/unicode/1f94c.png?v8", "curly_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b1.png?v8", "curly_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b1.png?v8", "curly_loop": "https://github.githubassets.com/images/icons/emoji/unicode/27b0.png?v8", "currency_exchange": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b1.png?v8", "curry": "https://github.githubassets.com/images/icons/emoji/unicode/1f35b.png?v8", "cursing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92c.png?v8", "custard": "https://github.githubassets.com/images/icons/emoji/unicode/1f36e.png?v8", "customs": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c3.png?v8", "cut_of_meat": "https://github.githubassets.com/images/icons/emoji/unicode/1f969.png?v8", "cyclone": "https://github.githubassets.com/images/icons/emoji/unicode/1f300.png?v8", "cyprus": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fe.png?v8", "czech_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ff.png?v8", "dagger": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e1.png?v8", "dancer": "https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8", "dancers": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f.png?v8", "dancing_men": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2642.png?v8", "dancing_women": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2640.png?v8", "dango": "https://github.githubassets.com/images/icons/emoji/unicode/1f361.png?v8", "dark_sunglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f576.png?v8", "dart": "https://github.githubassets.com/images/icons/emoji/unicode/1f3af.png?v8", "dash": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a8.png?v8", "date": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c5.png?v8", "de": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ea.png?v8", "deaf_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2642.png?v8", "deaf_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf.png?v8", "deaf_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2640.png?v8", "deciduous_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f333.png?v8", "deer": "https://github.githubassets.com/images/icons/emoji/unicode/1f98c.png?v8", "denmark": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f0.png?v8", "department_store": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ec.png?v8", "derelict_house": "https://github.githubassets.com/images/icons/emoji/unicode/1f3da.png?v8", "desert": "https://github.githubassets.com/images/icons/emoji/unicode/1f3dc.png?v8", "desert_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f3dd.png?v8", "desktop_computer": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a5.png?v8", "detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575.png?v8", "diamond_shape_with_a_dot_inside": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a0.png?v8", "diamonds": "https://github.githubassets.com/images/icons/emoji/unicode/2666.png?v8", "diego_garcia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ec.png?v8", "disappointed": "https://github.githubassets.com/images/icons/emoji/unicode/1f61e.png?v8", "disappointed_relieved": "https://github.githubassets.com/images/icons/emoji/unicode/1f625.png?v8", "disguised_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f978.png?v8", "diving_mask": "https://github.githubassets.com/images/icons/emoji/unicode/1f93f.png?v8", "diya_lamp": "https://github.githubassets.com/images/icons/emoji/unicode/1fa94.png?v8", "dizzy": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ab.png?v8", "dizzy_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f635.png?v8", "djibouti": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ef.png?v8", "dna": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ec.png?v8", "do_not_litter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6af.png?v8", "dodo": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a4.png?v8", "dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f436.png?v8", "dog2": "https://github.githubassets.com/images/icons/emoji/unicode/1f415.png?v8", "dollar": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b5.png?v8", "dolls": "https://github.githubassets.com/images/icons/emoji/unicode/1f38e.png?v8", "dolphin": "https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8", "dominica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f2.png?v8", "dominican_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f4.png?v8", "door": "https://github.githubassets.com/images/icons/emoji/unicode/1f6aa.png?v8", "doughnut": "https://github.githubassets.com/images/icons/emoji/unicode/1f369.png?v8", "dove": "https://github.githubassets.com/images/icons/emoji/unicode/1f54a.png?v8", "dragon": "https://github.githubassets.com/images/icons/emoji/unicode/1f409.png?v8", "dragon_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f432.png?v8", "dress": "https://github.githubassets.com/images/icons/emoji/unicode/1f457.png?v8", "dromedary_camel": "https://github.githubassets.com/images/icons/emoji/unicode/1f42a.png?v8", "drooling_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f924.png?v8", "drop_of_blood": "https://github.githubassets.com/images/icons/emoji/unicode/1fa78.png?v8", "droplet": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a7.png?v8", "drum": "https://github.githubassets.com/images/icons/emoji/unicode/1f941.png?v8", "duck": "https://github.githubassets.com/images/icons/emoji/unicode/1f986.png?v8", "dumpling": "https://github.githubassets.com/images/icons/emoji/unicode/1f95f.png?v8", "dvd": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c0.png?v8", "e-mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8", "eagle": "https://github.githubassets.com/images/icons/emoji/unicode/1f985.png?v8", "ear": "https://github.githubassets.com/images/icons/emoji/unicode/1f442.png?v8", "ear_of_rice": "https://github.githubassets.com/images/icons/emoji/unicode/1f33e.png?v8", "ear_with_hearing_aid": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bb.png?v8", "earth_africa": "https://github.githubassets.com/images/icons/emoji/unicode/1f30d.png?v8", "earth_americas": "https://github.githubassets.com/images/icons/emoji/unicode/1f30e.png?v8", "earth_asia": "https://github.githubassets.com/images/icons/emoji/unicode/1f30f.png?v8", "ecuador": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e8.png?v8", "egg": "https://github.githubassets.com/images/icons/emoji/unicode/1f95a.png?v8", "eggplant": "https://github.githubassets.com/images/icons/emoji/unicode/1f346.png?v8", "egypt": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ec.png?v8", "eight": "https://github.githubassets.com/images/icons/emoji/unicode/0038-20e3.png?v8", "eight_pointed_black_star": "https://github.githubassets.com/images/icons/emoji/unicode/2734.png?v8", "eight_spoked_asterisk": "https://github.githubassets.com/images/icons/emoji/unicode/2733.png?v8", "eject_button": "https://github.githubassets.com/images/icons/emoji/unicode/23cf.png?v8", "el_salvador": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fb.png?v8", "electric_plug": "https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png?v8", "electron": "https://github.githubassets.com/images/icons/emoji/electron.png?v8", "elephant": "https://github.githubassets.com/images/icons/emoji/unicode/1f418.png?v8", "elevator": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d7.png?v8", "elf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd.png?v8", "elf_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2642.png?v8", "elf_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2640.png?v8", "email": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8", "end": "https://github.githubassets.com/images/icons/emoji/unicode/1f51a.png?v8", "england": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0065-e006e-e0067-e007f.png?v8", "envelope": "https://github.githubassets.com/images/icons/emoji/unicode/2709.png?v8", "envelope_with_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e9.png?v8", "equatorial_guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f6.png?v8", "eritrea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f7.png?v8", "es": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f8.png?v8", "estonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ea.png?v8", "ethiopia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f9.png?v8", "eu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8", "euro": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b6.png?v8", "european_castle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f0.png?v8", "european_post_office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e4.png?v8", "european_union": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8", "evergreen_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f332.png?v8", "exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8", "exploding_head": "https://github.githubassets.com/images/icons/emoji/unicode/1f92f.png?v8", "expressionless": "https://github.githubassets.com/images/icons/emoji/unicode/1f611.png?v8", "eye": "https://github.githubassets.com/images/icons/emoji/unicode/1f441.png?v8", "eye_speech_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f441-1f5e8.png?v8", "eyeglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f453.png?v8", "eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f440.png?v8", "face_exhaling": "https://github.githubassets.com/images/icons/emoji/unicode/1f62e-1f4a8.png?v8", "face_in_clouds": "https://github.githubassets.com/images/icons/emoji/unicode/1f636-1f32b.png?v8", "face_with_head_bandage": "https://github.githubassets.com/images/icons/emoji/unicode/1f915.png?v8", "face_with_spiral_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f635-1f4ab.png?v8", "face_with_thermometer": "https://github.githubassets.com/images/icons/emoji/unicode/1f912.png?v8", "facepalm": "https://github.githubassets.com/images/icons/emoji/unicode/1f926.png?v8", "facepunch": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", "factory": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ed.png?v8", "factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3ed.png?v8", "fairy": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da.png?v8", "fairy_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2642.png?v8", "fairy_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2640.png?v8", "falafel": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c6.png?v8", "falkland_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f0.png?v8", "fallen_leaf": "https://github.githubassets.com/images/icons/emoji/unicode/1f342.png?v8", "family": "https://github.githubassets.com/images/icons/emoji/unicode/1f46a.png?v8", "family_man_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466.png?v8", "family_man_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466-1f466.png?v8", "family_man_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467.png?v8", "family_man_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f466.png?v8", "family_man_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f467.png?v8", "family_man_man_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466.png?v8", "family_man_man_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466-1f466.png?v8", "family_man_man_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467.png?v8", "family_man_man_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f466.png?v8", "family_man_man_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f467.png?v8", "family_man_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466.png?v8", "family_man_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466-1f466.png?v8", "family_man_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467.png?v8", "family_man_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f466.png?v8", "family_man_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f467.png?v8", "family_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466.png?v8", "family_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466-1f466.png?v8", "family_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467.png?v8", "family_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f466.png?v8", "family_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f467.png?v8", "family_woman_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466.png?v8", "family_woman_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466-1f466.png?v8", "family_woman_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467.png?v8", "family_woman_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f466.png?v8", "family_woman_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f467.png?v8", "farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f33e.png?v8", "faroe_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f4.png?v8", "fast_forward": "https://github.githubassets.com/images/icons/emoji/unicode/23e9.png?v8", "fax": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e0.png?v8", "fearful": "https://github.githubassets.com/images/icons/emoji/unicode/1f628.png?v8", "feather": "https://github.githubassets.com/images/icons/emoji/unicode/1fab6.png?v8", "feelsgood": "https://github.githubassets.com/images/icons/emoji/feelsgood.png?v8", "feet": "https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8", "female_detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575-2640.png?v8", "female_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2640.png?v8", "ferris_wheel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a1.png?v8", "ferry": "https://github.githubassets.com/images/icons/emoji/unicode/26f4.png?v8", "field_hockey": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d1.png?v8", "fiji": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ef.png?v8", "file_cabinet": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c4.png?v8", "file_folder": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c1.png?v8", "film_projector": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fd.png?v8", "film_strip": "https://github.githubassets.com/images/icons/emoji/unicode/1f39e.png?v8", "finland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ee.png?v8", "finnadie": "https://github.githubassets.com/images/icons/emoji/finnadie.png?v8", "fire": "https://github.githubassets.com/images/icons/emoji/unicode/1f525.png?v8", "fire_engine": "https://github.githubassets.com/images/icons/emoji/unicode/1f692.png?v8", "fire_extinguisher": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ef.png?v8", "firecracker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e8.png?v8", "firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f692.png?v8", "fireworks": "https://github.githubassets.com/images/icons/emoji/unicode/1f386.png?v8", "first_quarter_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f313.png?v8", "first_quarter_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31b.png?v8", "fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f41f.png?v8", "fish_cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f365.png?v8", "fishing_pole_and_fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a3.png?v8", "fist": "https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8", "fist_left": "https://github.githubassets.com/images/icons/emoji/unicode/1f91b.png?v8", "fist_oncoming": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", "fist_raised": "https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8", "fist_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f91c.png?v8", "five": "https://github.githubassets.com/images/icons/emoji/unicode/0035-20e3.png?v8", "flags": "https://github.githubassets.com/images/icons/emoji/unicode/1f38f.png?v8", "flamingo": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a9.png?v8", "flashlight": "https://github.githubassets.com/images/icons/emoji/unicode/1f526.png?v8", "flat_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f97f.png?v8", "flatbread": "https://github.githubassets.com/images/icons/emoji/unicode/1fad3.png?v8", "fleur_de_lis": "https://github.githubassets.com/images/icons/emoji/unicode/269c.png?v8", "flight_arrival": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ec.png?v8", "flight_departure": "https://github.githubassets.com/images/icons/emoji/unicode/1f6eb.png?v8", "flipper": "https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8", "floppy_disk": "https://github.githubassets.com/images/icons/emoji/unicode/1f4be.png?v8", "flower_playing_cards": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b4.png?v8", "flushed": "https://github.githubassets.com/images/icons/emoji/unicode/1f633.png?v8", "fly": "https://github.githubassets.com/images/icons/emoji/unicode/1fab0.png?v8", "flying_disc": "https://github.githubassets.com/images/icons/emoji/unicode/1f94f.png?v8", "flying_saucer": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f8.png?v8", "fog": "https://github.githubassets.com/images/icons/emoji/unicode/1f32b.png?v8", "foggy": "https://github.githubassets.com/images/icons/emoji/unicode/1f301.png?v8", "fondue": "https://github.githubassets.com/images/icons/emoji/unicode/1fad5.png?v8", "foot": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b6.png?v8", "football": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c8.png?v8", "footprints": "https://github.githubassets.com/images/icons/emoji/unicode/1f463.png?v8", "fork_and_knife": "https://github.githubassets.com/images/icons/emoji/unicode/1f374.png?v8", "fortune_cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f960.png?v8", "fountain": "https://github.githubassets.com/images/icons/emoji/unicode/26f2.png?v8", "fountain_pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f58b.png?v8", "four": "https://github.githubassets.com/images/icons/emoji/unicode/0034-20e3.png?v8", "four_leaf_clover": "https://github.githubassets.com/images/icons/emoji/unicode/1f340.png?v8", "fox_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f98a.png?v8", "fr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f7.png?v8", "framed_picture": "https://github.githubassets.com/images/icons/emoji/unicode/1f5bc.png?v8", "free": "https://github.githubassets.com/images/icons/emoji/unicode/1f193.png?v8", "french_guiana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1eb.png?v8", "french_polynesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1eb.png?v8", "french_southern_territories": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1eb.png?v8", "fried_egg": "https://github.githubassets.com/images/icons/emoji/unicode/1f373.png?v8", "fried_shrimp": "https://github.githubassets.com/images/icons/emoji/unicode/1f364.png?v8", "fries": "https://github.githubassets.com/images/icons/emoji/unicode/1f35f.png?v8", "frog": "https://github.githubassets.com/images/icons/emoji/unicode/1f438.png?v8", "frowning": "https://github.githubassets.com/images/icons/emoji/unicode/1f626.png?v8", "frowning_face": "https://github.githubassets.com/images/icons/emoji/unicode/2639.png?v8", "frowning_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2642.png?v8", "frowning_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d.png?v8", "frowning_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2640.png?v8", "fu": "https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8", "fuelpump": "https://github.githubassets.com/images/icons/emoji/unicode/26fd.png?v8", "full_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f315.png?v8", "full_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31d.png?v8", "funeral_urn": "https://github.githubassets.com/images/icons/emoji/unicode/26b1.png?v8", "gabon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e6.png?v8", "gambia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f2.png?v8", "game_die": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b2.png?v8", "garlic": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c4.png?v8", "gb": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8", "gear": "https://github.githubassets.com/images/icons/emoji/unicode/2699.png?v8", "gem": "https://github.githubassets.com/images/icons/emoji/unicode/1f48e.png?v8", "gemini": "https://github.githubassets.com/images/icons/emoji/unicode/264a.png?v8", "genie": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de.png?v8", "genie_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2642.png?v8", "genie_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2640.png?v8", "georgia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ea.png?v8", "ghana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ed.png?v8", "ghost": "https://github.githubassets.com/images/icons/emoji/unicode/1f47b.png?v8", "gibraltar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ee.png?v8", "gift": "https://github.githubassets.com/images/icons/emoji/unicode/1f381.png?v8", "gift_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49d.png?v8", "giraffe": "https://github.githubassets.com/images/icons/emoji/unicode/1f992.png?v8", "girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f467.png?v8", "globe_with_meridians": "https://github.githubassets.com/images/icons/emoji/unicode/1f310.png?v8", "gloves": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e4.png?v8", "goal_net": "https://github.githubassets.com/images/icons/emoji/unicode/1f945.png?v8", "goat": "https://github.githubassets.com/images/icons/emoji/unicode/1f410.png?v8", "goberserk": "https://github.githubassets.com/images/icons/emoji/goberserk.png?v8", "godmode": "https://github.githubassets.com/images/icons/emoji/godmode.png?v8", "goggles": "https://github.githubassets.com/images/icons/emoji/unicode/1f97d.png?v8", "golf": "https://github.githubassets.com/images/icons/emoji/unicode/26f3.png?v8", "golfing": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc.png?v8", "golfing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2642.png?v8", "golfing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2640.png?v8", "gorilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f98d.png?v8", "grapes": "https://github.githubassets.com/images/icons/emoji/unicode/1f347.png?v8", "greece": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f7.png?v8", "green_apple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34f.png?v8", "green_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d7.png?v8", "green_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e2.png?v8", "green_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49a.png?v8", "green_salad": "https://github.githubassets.com/images/icons/emoji/unicode/1f957.png?v8", "green_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e9.png?v8", "greenland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f1.png?v8", "grenada": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e9.png?v8", "grey_exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2755.png?v8", "grey_question": "https://github.githubassets.com/images/icons/emoji/unicode/2754.png?v8", "grimacing": "https://github.githubassets.com/images/icons/emoji/unicode/1f62c.png?v8", "grin": "https://github.githubassets.com/images/icons/emoji/unicode/1f601.png?v8", "grinning": "https://github.githubassets.com/images/icons/emoji/unicode/1f600.png?v8", "guadeloupe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f5.png?v8", "guam": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fa.png?v8", "guard": "https://github.githubassets.com/images/icons/emoji/unicode/1f482.png?v8", "guardsman": "https://github.githubassets.com/images/icons/emoji/unicode/1f482-2642.png?v8", "guardswoman": "https://github.githubassets.com/images/icons/emoji/unicode/1f482-2640.png?v8", "guatemala": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f9.png?v8", "guernsey": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ec.png?v8", "guide_dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ae.png?v8", "guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f3.png?v8", "guinea_bissau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fc.png?v8", "guitar": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b8.png?v8", "gun": "https://github.githubassets.com/images/icons/emoji/unicode/1f52b.png?v8", "guyana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fe.png?v8", "haircut": "https://github.githubassets.com/images/icons/emoji/unicode/1f487.png?v8", "haircut_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f487-2642.png?v8", "haircut_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f487-2640.png?v8", "haiti": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f9.png?v8", "hamburger": "https://github.githubassets.com/images/icons/emoji/unicode/1f354.png?v8", "hammer": "https://github.githubassets.com/images/icons/emoji/unicode/1f528.png?v8", "hammer_and_pick": "https://github.githubassets.com/images/icons/emoji/unicode/2692.png?v8", "hammer_and_wrench": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png?v8", "hamster": "https://github.githubassets.com/images/icons/emoji/unicode/1f439.png?v8", "hand": "https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8", "hand_over_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f92d.png?v8", "handbag": "https://github.githubassets.com/images/icons/emoji/unicode/1f45c.png?v8", "handball_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e.png?v8", "handshake": "https://github.githubassets.com/images/icons/emoji/unicode/1f91d.png?v8", "hankey": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8", "hash": "https://github.githubassets.com/images/icons/emoji/unicode/0023-20e3.png?v8", "hatched_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f425.png?v8", "hatching_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f423.png?v8", "headphones": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a7.png?v8", "headstone": "https://github.githubassets.com/images/icons/emoji/unicode/1faa6.png?v8", "health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2695.png?v8", "hear_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f649.png?v8", "heard_mcdonald_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f2.png?v8", "heart": "https://github.githubassets.com/images/icons/emoji/unicode/2764.png?v8", "heart_decoration": "https://github.githubassets.com/images/icons/emoji/unicode/1f49f.png?v8", "heart_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f60d.png?v8", "heart_eyes_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63b.png?v8", "heart_on_fire": "https://github.githubassets.com/images/icons/emoji/unicode/2764-1f525.png?v8", "heartbeat": "https://github.githubassets.com/images/icons/emoji/unicode/1f493.png?v8", "heartpulse": "https://github.githubassets.com/images/icons/emoji/unicode/1f497.png?v8", "hearts": "https://github.githubassets.com/images/icons/emoji/unicode/2665.png?v8", "heavy_check_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2714.png?v8", "heavy_division_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2797.png?v8", "heavy_dollar_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b2.png?v8", "heavy_exclamation_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8", "heavy_heart_exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2763.png?v8", "heavy_minus_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2796.png?v8", "heavy_multiplication_x": "https://github.githubassets.com/images/icons/emoji/unicode/2716.png?v8", "heavy_plus_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2795.png?v8", "hedgehog": "https://github.githubassets.com/images/icons/emoji/unicode/1f994.png?v8", "helicopter": "https://github.githubassets.com/images/icons/emoji/unicode/1f681.png?v8", "herb": "https://github.githubassets.com/images/icons/emoji/unicode/1f33f.png?v8", "hibiscus": "https://github.githubassets.com/images/icons/emoji/unicode/1f33a.png?v8", "high_brightness": "https://github.githubassets.com/images/icons/emoji/unicode/1f506.png?v8", "high_heel": "https://github.githubassets.com/images/icons/emoji/unicode/1f460.png?v8", "hiking_boot": "https://github.githubassets.com/images/icons/emoji/unicode/1f97e.png?v8", "hindu_temple": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d5.png?v8", "hippopotamus": "https://github.githubassets.com/images/icons/emoji/unicode/1f99b.png?v8", "hocho": "https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8", "hole": "https://github.githubassets.com/images/icons/emoji/unicode/1f573.png?v8", "honduras": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f3.png?v8", "honey_pot": "https://github.githubassets.com/images/icons/emoji/unicode/1f36f.png?v8", "honeybee": "https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8", "hong_kong": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f0.png?v8", "hook": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9d.png?v8", "horse": "https://github.githubassets.com/images/icons/emoji/unicode/1f434.png?v8", "horse_racing": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c7.png?v8", "hospital": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e5.png?v8", "hot_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f975.png?v8", "hot_pepper": "https://github.githubassets.com/images/icons/emoji/unicode/1f336.png?v8", "hotdog": "https://github.githubassets.com/images/icons/emoji/unicode/1f32d.png?v8", "hotel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e8.png?v8", "hotsprings": "https://github.githubassets.com/images/icons/emoji/unicode/2668.png?v8", "hourglass": "https://github.githubassets.com/images/icons/emoji/unicode/231b.png?v8", "hourglass_flowing_sand": "https://github.githubassets.com/images/icons/emoji/unicode/23f3.png?v8", "house": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e0.png?v8", "house_with_garden": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e1.png?v8", "houses": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d8.png?v8", "hugs": "https://github.githubassets.com/images/icons/emoji/unicode/1f917.png?v8", "hungary": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1fa.png?v8", "hurtrealbad": "https://github.githubassets.com/images/icons/emoji/hurtrealbad.png?v8", "hushed": "https://github.githubassets.com/images/icons/emoji/unicode/1f62f.png?v8", "hut": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d6.png?v8", "ice_cream": "https://github.githubassets.com/images/icons/emoji/unicode/1f368.png?v8", "ice_cube": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ca.png?v8", "ice_hockey": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d2.png?v8", "ice_skate": "https://github.githubassets.com/images/icons/emoji/unicode/26f8.png?v8", "icecream": "https://github.githubassets.com/images/icons/emoji/unicode/1f366.png?v8", "iceland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f8.png?v8", "id": "https://github.githubassets.com/images/icons/emoji/unicode/1f194.png?v8", "ideograph_advantage": "https://github.githubassets.com/images/icons/emoji/unicode/1f250.png?v8", "imp": "https://github.githubassets.com/images/icons/emoji/unicode/1f47f.png?v8", "inbox_tray": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e5.png?v8", "incoming_envelope": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e8.png?v8", "india": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f3.png?v8", "indonesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e9.png?v8", "infinity": "https://github.githubassets.com/images/icons/emoji/unicode/267e.png?v8", "information_desk_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8", "information_source": "https://github.githubassets.com/images/icons/emoji/unicode/2139.png?v8", "innocent": "https://github.githubassets.com/images/icons/emoji/unicode/1f607.png?v8", "interrobang": "https://github.githubassets.com/images/icons/emoji/unicode/2049.png?v8", "iphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f1.png?v8", "iran": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f7.png?v8", "iraq": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f6.png?v8", "ireland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1ea.png?v8", "isle_of_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f2.png?v8", "israel": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f1.png?v8", "it": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f9.png?v8", "izakaya_lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8", "jack_o_lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f383.png?v8", "jamaica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f2.png?v8", "japan": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fe.png?v8", "japanese_castle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ef.png?v8", "japanese_goblin": "https://github.githubassets.com/images/icons/emoji/unicode/1f47a.png?v8", "japanese_ogre": "https://github.githubassets.com/images/icons/emoji/unicode/1f479.png?v8", "jeans": "https://github.githubassets.com/images/icons/emoji/unicode/1f456.png?v8", "jersey": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1ea.png?v8", "jigsaw": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e9.png?v8", "jordan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f4.png?v8", "joy": "https://github.githubassets.com/images/icons/emoji/unicode/1f602.png?v8", "joy_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f639.png?v8", "joystick": "https://github.githubassets.com/images/icons/emoji/unicode/1f579.png?v8", "jp": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f5.png?v8", "judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2696.png?v8", "juggling_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f939.png?v8", "kangaroo": "https://github.githubassets.com/images/icons/emoji/unicode/1f998.png?v8", "kazakhstan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ff.png?v8", "kenya": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ea.png?v8", "key": "https://github.githubassets.com/images/icons/emoji/unicode/1f511.png?v8", "keyboard": "https://github.githubassets.com/images/icons/emoji/unicode/2328.png?v8", "keycap_ten": "https://github.githubassets.com/images/icons/emoji/unicode/1f51f.png?v8", "kick_scooter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f4.png?v8", "kimono": "https://github.githubassets.com/images/icons/emoji/unicode/1f458.png?v8", "kiribati": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ee.png?v8", "kiss": "https://github.githubassets.com/images/icons/emoji/unicode/1f48b.png?v8", "kissing": "https://github.githubassets.com/images/icons/emoji/unicode/1f617.png?v8", "kissing_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63d.png?v8", "kissing_closed_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f61a.png?v8", "kissing_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f618.png?v8", "kissing_smiling_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f619.png?v8", "kite": "https://github.githubassets.com/images/icons/emoji/unicode/1fa81.png?v8", "kiwi_fruit": "https://github.githubassets.com/images/icons/emoji/unicode/1f95d.png?v8", "kneeling_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2642.png?v8", "kneeling_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce.png?v8", "kneeling_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2640.png?v8", "knife": "https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8", "knot": "https://github.githubassets.com/images/icons/emoji/unicode/1faa2.png?v8", "koala": "https://github.githubassets.com/images/icons/emoji/unicode/1f428.png?v8", "koko": "https://github.githubassets.com/images/icons/emoji/unicode/1f201.png?v8", "kosovo": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fd-1f1f0.png?v8", "kr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f7.png?v8", "kuwait": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fc.png?v8", "kyrgyzstan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ec.png?v8", "lab_coat": "https://github.githubassets.com/images/icons/emoji/unicode/1f97c.png?v8", "label": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f7.png?v8", "lacrosse": "https://github.githubassets.com/images/icons/emoji/unicode/1f94d.png?v8", "ladder": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9c.png?v8", "lady_beetle": "https://github.githubassets.com/images/icons/emoji/unicode/1f41e.png?v8", "lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8", "laos": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e6.png?v8", "large_blue_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f535.png?v8", "large_blue_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f537.png?v8", "large_orange_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f536.png?v8", "last_quarter_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f317.png?v8", "last_quarter_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31c.png?v8", "latin_cross": "https://github.githubassets.com/images/icons/emoji/unicode/271d.png?v8", "latvia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fb.png?v8", "laughing": "https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8", "leafy_green": "https://github.githubassets.com/images/icons/emoji/unicode/1f96c.png?v8", "leaves": "https://github.githubassets.com/images/icons/emoji/unicode/1f343.png?v8", "lebanon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e7.png?v8", "ledger": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d2.png?v8", "left_luggage": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c5.png?v8", "left_right_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/2194.png?v8", "left_speech_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e8.png?v8", "leftwards_arrow_with_hook": "https://github.githubassets.com/images/icons/emoji/unicode/21a9.png?v8", "leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b5.png?v8", "lemon": "https://github.githubassets.com/images/icons/emoji/unicode/1f34b.png?v8", "leo": "https://github.githubassets.com/images/icons/emoji/unicode/264c.png?v8", "leopard": "https://github.githubassets.com/images/icons/emoji/unicode/1f406.png?v8", "lesotho": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f8.png?v8", "level_slider": "https://github.githubassets.com/images/icons/emoji/unicode/1f39a.png?v8", "liberia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f7.png?v8", "libra": "https://github.githubassets.com/images/icons/emoji/unicode/264e.png?v8", "libya": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fe.png?v8", "liechtenstein": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1ee.png?v8", "light_rail": "https://github.githubassets.com/images/icons/emoji/unicode/1f688.png?v8", "link": "https://github.githubassets.com/images/icons/emoji/unicode/1f517.png?v8", "lion": "https://github.githubassets.com/images/icons/emoji/unicode/1f981.png?v8", "lips": "https://github.githubassets.com/images/icons/emoji/unicode/1f444.png?v8", "lipstick": "https://github.githubassets.com/images/icons/emoji/unicode/1f484.png?v8", "lithuania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f9.png?v8", "lizard": "https://github.githubassets.com/images/icons/emoji/unicode/1f98e.png?v8", "llama": "https://github.githubassets.com/images/icons/emoji/unicode/1f999.png?v8", "lobster": "https://github.githubassets.com/images/icons/emoji/unicode/1f99e.png?v8", "lock": "https://github.githubassets.com/images/icons/emoji/unicode/1f512.png?v8", "lock_with_ink_pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f50f.png?v8", "lollipop": "https://github.githubassets.com/images/icons/emoji/unicode/1f36d.png?v8", "long_drum": "https://github.githubassets.com/images/icons/emoji/unicode/1fa98.png?v8", "loop": "https://github.githubassets.com/images/icons/emoji/unicode/27bf.png?v8", "lotion_bottle": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f4.png?v8", "lotus_position": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8.png?v8", "lotus_position_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2642.png?v8", "lotus_position_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2640.png?v8", "loud_sound": "https://github.githubassets.com/images/icons/emoji/unicode/1f50a.png?v8", "loudspeaker": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e2.png?v8", "love_hotel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e9.png?v8", "love_letter": "https://github.githubassets.com/images/icons/emoji/unicode/1f48c.png?v8", "love_you_gesture": "https://github.githubassets.com/images/icons/emoji/unicode/1f91f.png?v8", "low_brightness": "https://github.githubassets.com/images/icons/emoji/unicode/1f505.png?v8", "luggage": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f3.png?v8", "lungs": "https://github.githubassets.com/images/icons/emoji/unicode/1fac1.png?v8", "luxembourg": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fa.png?v8", "lying_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f925.png?v8", "m": "https://github.githubassets.com/images/icons/emoji/unicode/24c2.png?v8", "macau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f4.png?v8", "macedonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f0.png?v8", "madagascar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ec.png?v8", "mag": "https://github.githubassets.com/images/icons/emoji/unicode/1f50d.png?v8", "mag_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f50e.png?v8", "mage": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9.png?v8", "mage_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2642.png?v8", "mage_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2640.png?v8", "magic_wand": "https://github.githubassets.com/images/icons/emoji/unicode/1fa84.png?v8", "magnet": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f2.png?v8", "mahjong": "https://github.githubassets.com/images/icons/emoji/unicode/1f004.png?v8", "mailbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f4eb.png?v8", "mailbox_closed": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ea.png?v8", "mailbox_with_mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ec.png?v8", "mailbox_with_no_mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ed.png?v8", "malawi": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fc.png?v8", "malaysia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fe.png?v8", "maldives": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fb.png?v8", "male_detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575-2642.png?v8", "male_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2642.png?v8", "mali": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f1.png?v8", "malta": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f9.png?v8", "mammoth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a3.png?v8", "man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468.png?v8", "man_artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a8.png?v8", "man_astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f680.png?v8", "man_beard": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2642.png?v8", "man_cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938-2642.png?v8", "man_cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f373.png?v8", "man_dancing": "https://github.githubassets.com/images/icons/emoji/unicode/1f57a.png?v8", "man_facepalming": "https://github.githubassets.com/images/icons/emoji/unicode/1f926-2642.png?v8", "man_factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3ed.png?v8", "man_farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f33e.png?v8", "man_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f37c.png?v8", "man_firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f692.png?v8", "man_health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2695.png?v8", "man_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bd.png?v8", "man_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bc.png?v8", "man_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935-2642.png?v8", "man_judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2696.png?v8", "man_juggling": "https://github.githubassets.com/images/icons/emoji/unicode/1f939-2642.png?v8", "man_mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f527.png?v8", "man_office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bc.png?v8", "man_pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2708.png?v8", "man_playing_handball": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2642.png?v8", "man_playing_water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2642.png?v8", "man_scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f52c.png?v8", "man_shrugging": "https://github.githubassets.com/images/icons/emoji/unicode/1f937-2642.png?v8", "man_singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a4.png?v8", "man_student": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f393.png?v8", "man_teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3eb.png?v8", "man_technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bb.png?v8", "man_with_gua_pi_mao": "https://github.githubassets.com/images/icons/emoji/unicode/1f472.png?v8", "man_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9af.png?v8", "man_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473-2642.png?v8", "man_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2642.png?v8", "mandarin": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", "mango": "https://github.githubassets.com/images/icons/emoji/unicode/1f96d.png?v8", "mans_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8", "mantelpiece_clock": "https://github.githubassets.com/images/icons/emoji/unicode/1f570.png?v8", "manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bd.png?v8", "maple_leaf": "https://github.githubassets.com/images/icons/emoji/unicode/1f341.png?v8", "marshall_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ed.png?v8", "martial_arts_uniform": "https://github.githubassets.com/images/icons/emoji/unicode/1f94b.png?v8", "martinique": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f6.png?v8", "mask": "https://github.githubassets.com/images/icons/emoji/unicode/1f637.png?v8", "massage": "https://github.githubassets.com/images/icons/emoji/unicode/1f486.png?v8", "massage_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f486-2642.png?v8", "massage_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f486-2640.png?v8", "mate": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c9.png?v8", "mauritania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f7.png?v8", "mauritius": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fa.png?v8", "mayotte": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1f9.png?v8", "meat_on_bone": "https://github.githubassets.com/images/icons/emoji/unicode/1f356.png?v8", "mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f527.png?v8", "mechanical_arm": "https://github.githubassets.com/images/icons/emoji/unicode/1f9be.png?v8", "mechanical_leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bf.png?v8", "medal_military": "https://github.githubassets.com/images/icons/emoji/unicode/1f396.png?v8", "medal_sports": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c5.png?v8", "medical_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/2695.png?v8", "mega": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e3.png?v8", "melon": "https://github.githubassets.com/images/icons/emoji/unicode/1f348.png?v8", "memo": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8", "men_wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2642.png?v8", "mending_heart": "https://github.githubassets.com/images/icons/emoji/unicode/2764-1fa79.png?v8", "menorah": "https://github.githubassets.com/images/icons/emoji/unicode/1f54e.png?v8", "mens": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b9.png?v8", "mermaid": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2640.png?v8", "merman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2642.png?v8", "merperson": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc.png?v8", "metal": "https://github.githubassets.com/images/icons/emoji/unicode/1f918.png?v8", "metro": "https://github.githubassets.com/images/icons/emoji/unicode/1f687.png?v8", "mexico": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fd.png?v8", "microbe": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a0.png?v8", "micronesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f2.png?v8", "microphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a4.png?v8", "microscope": "https://github.githubassets.com/images/icons/emoji/unicode/1f52c.png?v8", "middle_finger": "https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8", "military_helmet": "https://github.githubassets.com/images/icons/emoji/unicode/1fa96.png?v8", "milk_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f95b.png?v8", "milky_way": "https://github.githubassets.com/images/icons/emoji/unicode/1f30c.png?v8", "minibus": "https://github.githubassets.com/images/icons/emoji/unicode/1f690.png?v8", "minidisc": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bd.png?v8", "mirror": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9e.png?v8", "mobile_phone_off": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f4.png?v8", "moldova": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e9.png?v8", "monaco": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e8.png?v8", "money_mouth_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f911.png?v8", "money_with_wings": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b8.png?v8", "moneybag": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b0.png?v8", "mongolia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f3.png?v8", "monkey": "https://github.githubassets.com/images/icons/emoji/unicode/1f412.png?v8", "monkey_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f435.png?v8", "monocle_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d0.png?v8", "monorail": "https://github.githubassets.com/images/icons/emoji/unicode/1f69d.png?v8", "montenegro": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ea.png?v8", "montserrat": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f8.png?v8", "moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8", "moon_cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f96e.png?v8", "morocco": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e6.png?v8", "mortar_board": "https://github.githubassets.com/images/icons/emoji/unicode/1f393.png?v8", "mosque": "https://github.githubassets.com/images/icons/emoji/unicode/1f54c.png?v8", "mosquito": "https://github.githubassets.com/images/icons/emoji/unicode/1f99f.png?v8", "motor_boat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e5.png?v8", "motor_scooter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f5.png?v8", "motorcycle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cd.png?v8", "motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bc.png?v8", "motorway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e3.png?v8", "mount_fuji": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fb.png?v8", "mountain": "https://github.githubassets.com/images/icons/emoji/unicode/26f0.png?v8", "mountain_bicyclist": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5.png?v8", "mountain_biking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2642.png?v8", "mountain_biking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2640.png?v8", "mountain_cableway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a0.png?v8", "mountain_railway": "https://github.githubassets.com/images/icons/emoji/unicode/1f69e.png?v8", "mountain_snow": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d4.png?v8", "mouse": "https://github.githubassets.com/images/icons/emoji/unicode/1f42d.png?v8", "mouse2": "https://github.githubassets.com/images/icons/emoji/unicode/1f401.png?v8", "mouse_trap": "https://github.githubassets.com/images/icons/emoji/unicode/1faa4.png?v8", "movie_camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a5.png?v8", "moyai": "https://github.githubassets.com/images/icons/emoji/unicode/1f5ff.png?v8", "mozambique": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ff.png?v8", "mrs_claus": "https://github.githubassets.com/images/icons/emoji/unicode/1f936.png?v8", "muscle": "https://github.githubassets.com/images/icons/emoji/unicode/1f4aa.png?v8", "mushroom": "https://github.githubassets.com/images/icons/emoji/unicode/1f344.png?v8", "musical_keyboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b9.png?v8", "musical_note": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b5.png?v8", "musical_score": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bc.png?v8", "mute": "https://github.githubassets.com/images/icons/emoji/unicode/1f507.png?v8", "mx_claus": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f384.png?v8", "myanmar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f2.png?v8", "nail_care": "https://github.githubassets.com/images/icons/emoji/unicode/1f485.png?v8", "name_badge": "https://github.githubassets.com/images/icons/emoji/unicode/1f4db.png?v8", "namibia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e6.png?v8", "national_park": "https://github.githubassets.com/images/icons/emoji/unicode/1f3de.png?v8", "nauru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f7.png?v8", "nauseated_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f922.png?v8", "nazar_amulet": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ff.png?v8", "neckbeard": "https://github.githubassets.com/images/icons/emoji/neckbeard.png?v8", "necktie": "https://github.githubassets.com/images/icons/emoji/unicode/1f454.png?v8", "negative_squared_cross_mark": "https://github.githubassets.com/images/icons/emoji/unicode/274e.png?v8", "nepal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f5.png?v8", "nerd_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f913.png?v8", "nesting_dolls": "https://github.githubassets.com/images/icons/emoji/unicode/1fa86.png?v8", "netherlands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f1.png?v8", "neutral_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f610.png?v8", "new": "https://github.githubassets.com/images/icons/emoji/unicode/1f195.png?v8", "new_caledonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e8.png?v8", "new_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f311.png?v8", "new_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31a.png?v8", "new_zealand": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ff.png?v8", "newspaper": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f0.png?v8", "newspaper_roll": "https://github.githubassets.com/images/icons/emoji/unicode/1f5de.png?v8", "next_track_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ed.png?v8", "ng": "https://github.githubassets.com/images/icons/emoji/unicode/1f196.png?v8", "ng_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8", "ng_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8", "nicaragua": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ee.png?v8", "niger": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ea.png?v8", "nigeria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ec.png?v8", "night_with_stars": "https://github.githubassets.com/images/icons/emoji/unicode/1f303.png?v8", "nine": "https://github.githubassets.com/images/icons/emoji/unicode/0039-20e3.png?v8", "ninja": "https://github.githubassets.com/images/icons/emoji/unicode/1f977.png?v8", "niue": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1fa.png?v8", "no_bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f515.png?v8", "no_bicycles": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b3.png?v8", "no_entry": "https://github.githubassets.com/images/icons/emoji/unicode/26d4.png?v8", "no_entry_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ab.png?v8", "no_good": "https://github.githubassets.com/images/icons/emoji/unicode/1f645.png?v8", "no_good_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8", "no_good_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8", "no_mobile_phones": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f5.png?v8", "no_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f636.png?v8", "no_pedestrians": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b7.png?v8", "no_smoking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ad.png?v8", "non-potable_water": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b1.png?v8", "norfolk_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1eb.png?v8", "north_korea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f5.png?v8", "northern_mariana_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f5.png?v8", "norway": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f4.png?v8", "nose": "https://github.githubassets.com/images/icons/emoji/unicode/1f443.png?v8", "notebook": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d3.png?v8", "notebook_with_decorative_cover": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d4.png?v8", "notes": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b6.png?v8", "nut_and_bolt": "https://github.githubassets.com/images/icons/emoji/unicode/1f529.png?v8", "o": "https://github.githubassets.com/images/icons/emoji/unicode/2b55.png?v8", "o2": "https://github.githubassets.com/images/icons/emoji/unicode/1f17e.png?v8", "ocean": "https://github.githubassets.com/images/icons/emoji/unicode/1f30a.png?v8", "octocat": "https://github.githubassets.com/images/icons/emoji/octocat.png?v8", "octopus": "https://github.githubassets.com/images/icons/emoji/unicode/1f419.png?v8", "oden": "https://github.githubassets.com/images/icons/emoji/unicode/1f362.png?v8", "office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e2.png?v8", "office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bc.png?v8", "oil_drum": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e2.png?v8", "ok": "https://github.githubassets.com/images/icons/emoji/unicode/1f197.png?v8", "ok_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f44c.png?v8", "ok_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f646-2642.png?v8", "ok_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f646.png?v8", "ok_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f646-2640.png?v8", "old_key": "https://github.githubassets.com/images/icons/emoji/unicode/1f5dd.png?v8", "older_adult": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d3.png?v8", "older_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f474.png?v8", "older_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f475.png?v8", "olive": "https://github.githubassets.com/images/icons/emoji/unicode/1fad2.png?v8", "om": "https://github.githubassets.com/images/icons/emoji/unicode/1f549.png?v8", "oman": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f4-1f1f2.png?v8", "on": "https://github.githubassets.com/images/icons/emoji/unicode/1f51b.png?v8", "oncoming_automobile": "https://github.githubassets.com/images/icons/emoji/unicode/1f698.png?v8", "oncoming_bus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68d.png?v8", "oncoming_police_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f694.png?v8", "oncoming_taxi": "https://github.githubassets.com/images/icons/emoji/unicode/1f696.png?v8", "one": "https://github.githubassets.com/images/icons/emoji/unicode/0031-20e3.png?v8", "one_piece_swimsuit": "https://github.githubassets.com/images/icons/emoji/unicode/1fa71.png?v8", "onion": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c5.png?v8", "open_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8", "open_file_folder": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c2.png?v8", "open_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f450.png?v8", "open_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f62e.png?v8", "open_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/2602.png?v8", "ophiuchus": "https://github.githubassets.com/images/icons/emoji/unicode/26ce.png?v8", "orange": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", "orange_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d9.png?v8", "orange_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e0.png?v8", "orange_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e1.png?v8", "orange_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e7.png?v8", "orangutan": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a7.png?v8", "orthodox_cross": "https://github.githubassets.com/images/icons/emoji/unicode/2626.png?v8", "otter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a6.png?v8", "outbox_tray": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e4.png?v8", "owl": "https://github.githubassets.com/images/icons/emoji/unicode/1f989.png?v8", "ox": "https://github.githubassets.com/images/icons/emoji/unicode/1f402.png?v8", "oyster": "https://github.githubassets.com/images/icons/emoji/unicode/1f9aa.png?v8", "package": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png?v8", "page_facing_up": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c4.png?v8", "page_with_curl": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c3.png?v8", "pager": "https://github.githubassets.com/images/icons/emoji/unicode/1f4df.png?v8", "paintbrush": "https://github.githubassets.com/images/icons/emoji/unicode/1f58c.png?v8", "pakistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f0.png?v8", "palau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fc.png?v8", "palestinian_territories": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f8.png?v8", "palm_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f334.png?v8", "palms_up_together": "https://github.githubassets.com/images/icons/emoji/unicode/1f932.png?v8", "panama": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1e6.png?v8", "pancakes": "https://github.githubassets.com/images/icons/emoji/unicode/1f95e.png?v8", "panda_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f43c.png?v8", "paperclip": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ce.png?v8", "paperclips": "https://github.githubassets.com/images/icons/emoji/unicode/1f587.png?v8", "papua_new_guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ec.png?v8", "parachute": "https://github.githubassets.com/images/icons/emoji/unicode/1fa82.png?v8", "paraguay": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fe.png?v8", "parasol_on_ground": "https://github.githubassets.com/images/icons/emoji/unicode/26f1.png?v8", "parking": "https://github.githubassets.com/images/icons/emoji/unicode/1f17f.png?v8", "parrot": "https://github.githubassets.com/images/icons/emoji/unicode/1f99c.png?v8", "part_alternation_mark": "https://github.githubassets.com/images/icons/emoji/unicode/303d.png?v8", "partly_sunny": "https://github.githubassets.com/images/icons/emoji/unicode/26c5.png?v8", "partying_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f973.png?v8", "passenger_ship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f3.png?v8", "passport_control": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c2.png?v8", "pause_button": "https://github.githubassets.com/images/icons/emoji/unicode/23f8.png?v8", "paw_prints": "https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8", "peace_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/262e.png?v8", "peach": "https://github.githubassets.com/images/icons/emoji/unicode/1f351.png?v8", "peacock": "https://github.githubassets.com/images/icons/emoji/unicode/1f99a.png?v8", "peanuts": "https://github.githubassets.com/images/icons/emoji/unicode/1f95c.png?v8", "pear": "https://github.githubassets.com/images/icons/emoji/unicode/1f350.png?v8", "pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f58a.png?v8", "pencil": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8", "pencil2": "https://github.githubassets.com/images/icons/emoji/unicode/270f.png?v8", "penguin": "https://github.githubassets.com/images/icons/emoji/unicode/1f427.png?v8", "pensive": "https://github.githubassets.com/images/icons/emoji/unicode/1f614.png?v8", "people_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f91d-1f9d1.png?v8", "people_hugging": "https://github.githubassets.com/images/icons/emoji/unicode/1fac2.png?v8", "performing_arts": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png?v8", "persevere": "https://github.githubassets.com/images/icons/emoji/unicode/1f623.png?v8", "person_bald": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b2.png?v8", "person_curly_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b1.png?v8", "person_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f37c.png?v8", "person_fencing": "https://github.githubassets.com/images/icons/emoji/unicode/1f93a.png?v8", "person_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bd.png?v8", "person_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bc.png?v8", "person_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935.png?v8", "person_red_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b0.png?v8", "person_white_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b3.png?v8", "person_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9af.png?v8", "person_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473.png?v8", "person_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470.png?v8", "peru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ea.png?v8", "petri_dish": "https://github.githubassets.com/images/icons/emoji/unicode/1f9eb.png?v8", "philippines": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ed.png?v8", "phone": "https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8", "pick": "https://github.githubassets.com/images/icons/emoji/unicode/26cf.png?v8", "pickup_truck": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fb.png?v8", "pie": "https://github.githubassets.com/images/icons/emoji/unicode/1f967.png?v8", "pig": "https://github.githubassets.com/images/icons/emoji/unicode/1f437.png?v8", "pig2": "https://github.githubassets.com/images/icons/emoji/unicode/1f416.png?v8", "pig_nose": "https://github.githubassets.com/images/icons/emoji/unicode/1f43d.png?v8", "pill": "https://github.githubassets.com/images/icons/emoji/unicode/1f48a.png?v8", "pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2708.png?v8", "pinata": "https://github.githubassets.com/images/icons/emoji/unicode/1fa85.png?v8", "pinched_fingers": "https://github.githubassets.com/images/icons/emoji/unicode/1f90c.png?v8", "pinching_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f90f.png?v8", "pineapple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34d.png?v8", "ping_pong": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d3.png?v8", "pirate_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-2620.png?v8", "pisces": "https://github.githubassets.com/images/icons/emoji/unicode/2653.png?v8", "pitcairn_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f3.png?v8", "pizza": "https://github.githubassets.com/images/icons/emoji/unicode/1f355.png?v8", "placard": "https://github.githubassets.com/images/icons/emoji/unicode/1faa7.png?v8", "place_of_worship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d0.png?v8", "plate_with_cutlery": "https://github.githubassets.com/images/icons/emoji/unicode/1f37d.png?v8", "play_or_pause_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ef.png?v8", "pleading_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f97a.png?v8", "plunger": "https://github.githubassets.com/images/icons/emoji/unicode/1faa0.png?v8", "point_down": "https://github.githubassets.com/images/icons/emoji/unicode/1f447.png?v8", "point_left": "https://github.githubassets.com/images/icons/emoji/unicode/1f448.png?v8", "point_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f449.png?v8", "point_up": "https://github.githubassets.com/images/icons/emoji/unicode/261d.png?v8", "point_up_2": "https://github.githubassets.com/images/icons/emoji/unicode/1f446.png?v8", "poland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f1.png?v8", "polar_bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f43b-2744.png?v8", "police_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f693.png?v8", "police_officer": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", "policeman": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2642.png?v8", "policewoman": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2640.png?v8", "poodle": "https://github.githubassets.com/images/icons/emoji/unicode/1f429.png?v8", "poop": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8", "popcorn": "https://github.githubassets.com/images/icons/emoji/unicode/1f37f.png?v8", "portugal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f9.png?v8", "post_office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e3.png?v8", "postal_horn": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ef.png?v8", "postbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ee.png?v8", "potable_water": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b0.png?v8", "potato": "https://github.githubassets.com/images/icons/emoji/unicode/1f954.png?v8", "potted_plant": "https://github.githubassets.com/images/icons/emoji/unicode/1fab4.png?v8", "pouch": "https://github.githubassets.com/images/icons/emoji/unicode/1f45d.png?v8", "poultry_leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f357.png?v8", "pound": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b7.png?v8", "pout": "https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8", "pouting_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63e.png?v8", "pouting_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e.png?v8", "pouting_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2642.png?v8", "pouting_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2640.png?v8", "pray": "https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png?v8", "prayer_beads": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ff.png?v8", "pregnant_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f930.png?v8", "pretzel": "https://github.githubassets.com/images/icons/emoji/unicode/1f968.png?v8", "previous_track_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ee.png?v8", "prince": "https://github.githubassets.com/images/icons/emoji/unicode/1f934.png?v8", "princess": "https://github.githubassets.com/images/icons/emoji/unicode/1f478.png?v8", "printer": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a8.png?v8", "probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f9af.png?v8", "puerto_rico": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f7.png?v8", "punch": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", "purple_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e3.png?v8", "purple_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49c.png?v8", "purple_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7ea.png?v8", "purse": "https://github.githubassets.com/images/icons/emoji/unicode/1f45b.png?v8", "pushpin": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cc.png?v8", "put_litter_in_its_place": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ae.png?v8", "qatar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f6-1f1e6.png?v8", "question": "https://github.githubassets.com/images/icons/emoji/unicode/2753.png?v8", "rabbit": "https://github.githubassets.com/images/icons/emoji/unicode/1f430.png?v8", "rabbit2": "https://github.githubassets.com/images/icons/emoji/unicode/1f407.png?v8", "raccoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f99d.png?v8", "racehorse": "https://github.githubassets.com/images/icons/emoji/unicode/1f40e.png?v8", "racing_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ce.png?v8", "radio": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fb.png?v8", "radio_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f518.png?v8", "radioactive": "https://github.githubassets.com/images/icons/emoji/unicode/2622.png?v8", "rage": "https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8", "rage1": "https://github.githubassets.com/images/icons/emoji/rage1.png?v8", "rage2": "https://github.githubassets.com/images/icons/emoji/rage2.png?v8", "rage3": "https://github.githubassets.com/images/icons/emoji/rage3.png?v8", "rage4": "https://github.githubassets.com/images/icons/emoji/rage4.png?v8", "railway_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f683.png?v8", "railway_track": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e4.png?v8", "rainbow": "https://github.githubassets.com/images/icons/emoji/unicode/1f308.png?v8", "rainbow_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-1f308.png?v8", "raised_back_of_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f91a.png?v8", "raised_eyebrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f928.png?v8", "raised_hand": "https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8", "raised_hand_with_fingers_splayed": "https://github.githubassets.com/images/icons/emoji/unicode/1f590.png?v8", "raised_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f64c.png?v8", "raising_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b.png?v8", "raising_hand_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2642.png?v8", "raising_hand_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2640.png?v8", "ram": "https://github.githubassets.com/images/icons/emoji/unicode/1f40f.png?v8", "ramen": "https://github.githubassets.com/images/icons/emoji/unicode/1f35c.png?v8", "rat": "https://github.githubassets.com/images/icons/emoji/unicode/1f400.png?v8", "razor": "https://github.githubassets.com/images/icons/emoji/unicode/1fa92.png?v8", "receipt": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fe.png?v8", "record_button": "https://github.githubassets.com/images/icons/emoji/unicode/23fa.png?v8", "recycle": "https://github.githubassets.com/images/icons/emoji/unicode/267b.png?v8", "red_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8", "red_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f534.png?v8", "red_envelope": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e7.png?v8", "red_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b0.png?v8", "red_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b0.png?v8", "red_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e5.png?v8", "registered": "https://github.githubassets.com/images/icons/emoji/unicode/00ae.png?v8", "relaxed": "https://github.githubassets.com/images/icons/emoji/unicode/263a.png?v8", "relieved": "https://github.githubassets.com/images/icons/emoji/unicode/1f60c.png?v8", "reminder_ribbon": "https://github.githubassets.com/images/icons/emoji/unicode/1f397.png?v8", "repeat": "https://github.githubassets.com/images/icons/emoji/unicode/1f501.png?v8", "repeat_one": "https://github.githubassets.com/images/icons/emoji/unicode/1f502.png?v8", "rescue_worker_helmet": "https://github.githubassets.com/images/icons/emoji/unicode/26d1.png?v8", "restroom": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bb.png?v8", "reunion": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1ea.png?v8", "revolving_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f49e.png?v8", "rewind": "https://github.githubassets.com/images/icons/emoji/unicode/23ea.png?v8", "rhinoceros": "https://github.githubassets.com/images/icons/emoji/unicode/1f98f.png?v8", "ribbon": "https://github.githubassets.com/images/icons/emoji/unicode/1f380.png?v8", "rice": "https://github.githubassets.com/images/icons/emoji/unicode/1f35a.png?v8", "rice_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f359.png?v8", "rice_cracker": "https://github.githubassets.com/images/icons/emoji/unicode/1f358.png?v8", "rice_scene": "https://github.githubassets.com/images/icons/emoji/unicode/1f391.png?v8", "right_anger_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f5ef.png?v8", "ring": "https://github.githubassets.com/images/icons/emoji/unicode/1f48d.png?v8", "ringed_planet": "https://github.githubassets.com/images/icons/emoji/unicode/1fa90.png?v8", "robot": "https://github.githubassets.com/images/icons/emoji/unicode/1f916.png?v8", "rock": "https://github.githubassets.com/images/icons/emoji/unicode/1faa8.png?v8", "rocket": "https://github.githubassets.com/images/icons/emoji/unicode/1f680.png?v8", "rofl": "https://github.githubassets.com/images/icons/emoji/unicode/1f923.png?v8", "roll_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f644.png?v8", "roll_of_paper": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fb.png?v8", "roller_coaster": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a2.png?v8", "roller_skate": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fc.png?v8", "romania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f4.png?v8", "rooster": "https://github.githubassets.com/images/icons/emoji/unicode/1f413.png?v8", "rose": "https://github.githubassets.com/images/icons/emoji/unicode/1f339.png?v8", "rosette": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f5.png?v8", "rotating_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a8.png?v8", "round_pushpin": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cd.png?v8", "rowboat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3.png?v8", "rowing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2642.png?v8", "rowing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2640.png?v8", "ru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fa.png?v8", "rugby_football": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c9.png?v8", "runner": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8", "running": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8", "running_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2642.png?v8", "running_shirt_with_sash": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bd.png?v8", "running_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2640.png?v8", "rwanda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fc.png?v8", "sa": "https://github.githubassets.com/images/icons/emoji/unicode/1f202.png?v8", "safety_pin": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f7.png?v8", "safety_vest": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ba.png?v8", "sagittarius": "https://github.githubassets.com/images/icons/emoji/unicode/2650.png?v8", "sailboat": "https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8", "sake": "https://github.githubassets.com/images/icons/emoji/unicode/1f376.png?v8", "salt": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c2.png?v8", "samoa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1f8.png?v8", "san_marino": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f2.png?v8", "sandal": "https://github.githubassets.com/images/icons/emoji/unicode/1f461.png?v8", "sandwich": "https://github.githubassets.com/images/icons/emoji/unicode/1f96a.png?v8", "santa": "https://github.githubassets.com/images/icons/emoji/unicode/1f385.png?v8", "sao_tome_principe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f9.png?v8", "sari": "https://github.githubassets.com/images/icons/emoji/unicode/1f97b.png?v8", "sassy_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8", "sassy_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8", "satellite": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e1.png?v8", "satisfied": "https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8", "saudi_arabia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e6.png?v8", "sauna_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2642.png?v8", "sauna_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6.png?v8", "sauna_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2640.png?v8", "sauropod": "https://github.githubassets.com/images/icons/emoji/unicode/1f995.png?v8", "saxophone": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b7.png?v8", "scarf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e3.png?v8", "school": "https://github.githubassets.com/images/icons/emoji/unicode/1f3eb.png?v8", "school_satchel": "https://github.githubassets.com/images/icons/emoji/unicode/1f392.png?v8", "scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f52c.png?v8", "scissors": "https://github.githubassets.com/images/icons/emoji/unicode/2702.png?v8", "scorpion": "https://github.githubassets.com/images/icons/emoji/unicode/1f982.png?v8", "scorpius": "https://github.githubassets.com/images/icons/emoji/unicode/264f.png?v8", "scotland": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0073-e0063-e0074-e007f.png?v8", "scream": "https://github.githubassets.com/images/icons/emoji/unicode/1f631.png?v8", "scream_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f640.png?v8", "screwdriver": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9b.png?v8", "scroll": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png?v8", "seal": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ad.png?v8", "seat": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ba.png?v8", "secret": "https://github.githubassets.com/images/icons/emoji/unicode/3299.png?v8", "see_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f648.png?v8", "seedling": "https://github.githubassets.com/images/icons/emoji/unicode/1f331.png?v8", "selfie": "https://github.githubassets.com/images/icons/emoji/unicode/1f933.png?v8", "senegal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f3.png?v8", "serbia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f8.png?v8", "service_dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f415-1f9ba.png?v8", "seven": "https://github.githubassets.com/images/icons/emoji/unicode/0037-20e3.png?v8", "sewing_needle": "https://github.githubassets.com/images/icons/emoji/unicode/1faa1.png?v8", "seychelles": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e8.png?v8", "shallow_pan_of_food": "https://github.githubassets.com/images/icons/emoji/unicode/1f958.png?v8", "shamrock": "https://github.githubassets.com/images/icons/emoji/unicode/2618.png?v8", "shark": "https://github.githubassets.com/images/icons/emoji/unicode/1f988.png?v8", "shaved_ice": "https://github.githubassets.com/images/icons/emoji/unicode/1f367.png?v8", "sheep": "https://github.githubassets.com/images/icons/emoji/unicode/1f411.png?v8", "shell": "https://github.githubassets.com/images/icons/emoji/unicode/1f41a.png?v8", "shield": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e1.png?v8", "shinto_shrine": "https://github.githubassets.com/images/icons/emoji/unicode/26e9.png?v8", "ship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a2.png?v8", "shipit": "https://github.githubassets.com/images/icons/emoji/shipit.png?v8", "shirt": "https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8", "shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8", "shopping": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cd.png?v8", "shopping_cart": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d2.png?v8", "shorts": "https://github.githubassets.com/images/icons/emoji/unicode/1fa73.png?v8", "shower": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bf.png?v8", "shrimp": "https://github.githubassets.com/images/icons/emoji/unicode/1f990.png?v8", "shrug": "https://github.githubassets.com/images/icons/emoji/unicode/1f937.png?v8", "shushing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92b.png?v8", "sierra_leone": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f1.png?v8", "signal_strength": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f6.png?v8", "singapore": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ec.png?v8", "singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a4.png?v8", "sint_maarten": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fd.png?v8", "six": "https://github.githubassets.com/images/icons/emoji/unicode/0036-20e3.png?v8", "six_pointed_star": "https://github.githubassets.com/images/icons/emoji/unicode/1f52f.png?v8", "skateboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f9.png?v8", "ski": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bf.png?v8", "skier": "https://github.githubassets.com/images/icons/emoji/unicode/26f7.png?v8", "skull": "https://github.githubassets.com/images/icons/emoji/unicode/1f480.png?v8", "skull_and_crossbones": "https://github.githubassets.com/images/icons/emoji/unicode/2620.png?v8", "skunk": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a8.png?v8", "sled": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f7.png?v8", "sleeping": "https://github.githubassets.com/images/icons/emoji/unicode/1f634.png?v8", "sleeping_bed": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cc.png?v8", "sleepy": "https://github.githubassets.com/images/icons/emoji/unicode/1f62a.png?v8", "slightly_frowning_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f641.png?v8", "slightly_smiling_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f642.png?v8", "slot_machine": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b0.png?v8", "sloth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a5.png?v8", "slovakia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f0.png?v8", "slovenia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ee.png?v8", "small_airplane": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e9.png?v8", "small_blue_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f539.png?v8", "small_orange_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f538.png?v8", "small_red_triangle": "https://github.githubassets.com/images/icons/emoji/unicode/1f53a.png?v8", "small_red_triangle_down": "https://github.githubassets.com/images/icons/emoji/unicode/1f53b.png?v8", "smile": "https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8", "smile_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f638.png?v8", "smiley": "https://github.githubassets.com/images/icons/emoji/unicode/1f603.png?v8", "smiley_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63a.png?v8", "smiling_face_with_tear": "https://github.githubassets.com/images/icons/emoji/unicode/1f972.png?v8", "smiling_face_with_three_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f970.png?v8", "smiling_imp": "https://github.githubassets.com/images/icons/emoji/unicode/1f608.png?v8", "smirk": "https://github.githubassets.com/images/icons/emoji/unicode/1f60f.png?v8", "smirk_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63c.png?v8", "smoking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ac.png?v8", "snail": "https://github.githubassets.com/images/icons/emoji/unicode/1f40c.png?v8", "snake": "https://github.githubassets.com/images/icons/emoji/unicode/1f40d.png?v8", "sneezing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f927.png?v8", "snowboarder": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c2.png?v8", "snowflake": "https://github.githubassets.com/images/icons/emoji/unicode/2744.png?v8", "snowman": "https://github.githubassets.com/images/icons/emoji/unicode/26c4.png?v8", "snowman_with_snow": "https://github.githubassets.com/images/icons/emoji/unicode/2603.png?v8", "soap": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fc.png?v8", "sob": "https://github.githubassets.com/images/icons/emoji/unicode/1f62d.png?v8", "soccer": "https://github.githubassets.com/images/icons/emoji/unicode/26bd.png?v8", "socks": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e6.png?v8", "softball": "https://github.githubassets.com/images/icons/emoji/unicode/1f94e.png?v8", "solomon_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e7.png?v8", "somalia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f4.png?v8", "soon": "https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png?v8", "sos": "https://github.githubassets.com/images/icons/emoji/unicode/1f198.png?v8", "sound": "https://github.githubassets.com/images/icons/emoji/unicode/1f509.png?v8", "south_africa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1e6.png?v8", "south_georgia_south_sandwich_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f8.png?v8", "south_sudan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f8.png?v8", "space_invader": "https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png?v8", "spades": "https://github.githubassets.com/images/icons/emoji/unicode/2660.png?v8", "spaghetti": "https://github.githubassets.com/images/icons/emoji/unicode/1f35d.png?v8", "sparkle": "https://github.githubassets.com/images/icons/emoji/unicode/2747.png?v8", "sparkler": "https://github.githubassets.com/images/icons/emoji/unicode/1f387.png?v8", "sparkles": "https://github.githubassets.com/images/icons/emoji/unicode/2728.png?v8", "sparkling_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f496.png?v8", "speak_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f64a.png?v8", "speaker": "https://github.githubassets.com/images/icons/emoji/unicode/1f508.png?v8", "speaking_head": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e3.png?v8", "speech_balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ac.png?v8", "speedboat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a4.png?v8", "spider": "https://github.githubassets.com/images/icons/emoji/unicode/1f577.png?v8", "spider_web": "https://github.githubassets.com/images/icons/emoji/unicode/1f578.png?v8", "spiral_calendar": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d3.png?v8", "spiral_notepad": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d2.png?v8", "sponge": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fd.png?v8", "spoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f944.png?v8", "squid": "https://github.githubassets.com/images/icons/emoji/unicode/1f991.png?v8", "sri_lanka": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f0.png?v8", "st_barthelemy": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f1.png?v8", "st_helena": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ed.png?v8", "st_kitts_nevis": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f3.png?v8", "st_lucia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e8.png?v8", "st_martin": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1eb.png?v8", "st_pierre_miquelon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f2.png?v8", "st_vincent_grenadines": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e8.png?v8", "stadium": "https://github.githubassets.com/images/icons/emoji/unicode/1f3df.png?v8", "standing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2642.png?v8", "standing_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd.png?v8", "standing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2640.png?v8", "star": "https://github.githubassets.com/images/icons/emoji/unicode/2b50.png?v8", "star2": "https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png?v8", "star_and_crescent": "https://github.githubassets.com/images/icons/emoji/unicode/262a.png?v8", "star_of_david": "https://github.githubassets.com/images/icons/emoji/unicode/2721.png?v8", "star_struck": "https://github.githubassets.com/images/icons/emoji/unicode/1f929.png?v8", "stars": "https://github.githubassets.com/images/icons/emoji/unicode/1f320.png?v8", "station": "https://github.githubassets.com/images/icons/emoji/unicode/1f689.png?v8", "statue_of_liberty": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fd.png?v8", "steam_locomotive": "https://github.githubassets.com/images/icons/emoji/unicode/1f682.png?v8", "stethoscope": "https://github.githubassets.com/images/icons/emoji/unicode/1fa7a.png?v8", "stew": "https://github.githubassets.com/images/icons/emoji/unicode/1f372.png?v8", "stop_button": "https://github.githubassets.com/images/icons/emoji/unicode/23f9.png?v8", "stop_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d1.png?v8", "stopwatch": "https://github.githubassets.com/images/icons/emoji/unicode/23f1.png?v8", "straight_ruler": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cf.png?v8", "strawberry": "https://github.githubassets.com/images/icons/emoji/unicode/1f353.png?v8", "stuck_out_tongue": "https://github.githubassets.com/images/icons/emoji/unicode/1f61b.png?v8", "stuck_out_tongue_closed_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f61d.png?v8", "stuck_out_tongue_winking_eye": "https://github.githubassets.com/images/icons/emoji/unicode/1f61c.png?v8", "student": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f393.png?v8", "studio_microphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f399.png?v8", "stuffed_flatbread": "https://github.githubassets.com/images/icons/emoji/unicode/1f959.png?v8", "sudan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e9.png?v8", "sun_behind_large_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f325.png?v8", "sun_behind_rain_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f326.png?v8", "sun_behind_small_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f324.png?v8", "sun_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31e.png?v8", "sunflower": "https://github.githubassets.com/images/icons/emoji/unicode/1f33b.png?v8", "sunglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f60e.png?v8", "sunny": "https://github.githubassets.com/images/icons/emoji/unicode/2600.png?v8", "sunrise": "https://github.githubassets.com/images/icons/emoji/unicode/1f305.png?v8", "sunrise_over_mountains": "https://github.githubassets.com/images/icons/emoji/unicode/1f304.png?v8", "superhero": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8.png?v8", "superhero_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2642.png?v8", "superhero_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2640.png?v8", "supervillain": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9.png?v8", "supervillain_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2642.png?v8", "supervillain_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2640.png?v8", "surfer": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4.png?v8", "surfing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2642.png?v8", "surfing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2640.png?v8", "suriname": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f7.png?v8", "sushi": "https://github.githubassets.com/images/icons/emoji/unicode/1f363.png?v8", "suspect": "https://github.githubassets.com/images/icons/emoji/suspect.png?v8", "suspension_railway": "https://github.githubassets.com/images/icons/emoji/unicode/1f69f.png?v8", "svalbard_jan_mayen": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ef.png?v8", "swan": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a2.png?v8", "swaziland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ff.png?v8", "sweat": "https://github.githubassets.com/images/icons/emoji/unicode/1f613.png?v8", "sweat_drops": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a6.png?v8", "sweat_smile": "https://github.githubassets.com/images/icons/emoji/unicode/1f605.png?v8", "sweden": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ea.png?v8", "sweet_potato": "https://github.githubassets.com/images/icons/emoji/unicode/1f360.png?v8", "swim_brief": "https://github.githubassets.com/images/icons/emoji/unicode/1fa72.png?v8", "swimmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca.png?v8", "swimming_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2642.png?v8", "swimming_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2640.png?v8", "switzerland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ed.png?v8", "symbols": "https://github.githubassets.com/images/icons/emoji/unicode/1f523.png?v8", "synagogue": "https://github.githubassets.com/images/icons/emoji/unicode/1f54d.png?v8", "syria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fe.png?v8", "syringe": "https://github.githubassets.com/images/icons/emoji/unicode/1f489.png?v8", "t-rex": "https://github.githubassets.com/images/icons/emoji/unicode/1f996.png?v8", "taco": "https://github.githubassets.com/images/icons/emoji/unicode/1f32e.png?v8", "tada": "https://github.githubassets.com/images/icons/emoji/unicode/1f389.png?v8", "taiwan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fc.png?v8", "tajikistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ef.png?v8", "takeout_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f961.png?v8", "tamale": "https://github.githubassets.com/images/icons/emoji/unicode/1fad4.png?v8", "tanabata_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f38b.png?v8", "tangerine": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", "tanzania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ff.png?v8", "taurus": "https://github.githubassets.com/images/icons/emoji/unicode/2649.png?v8", "taxi": "https://github.githubassets.com/images/icons/emoji/unicode/1f695.png?v8", "tea": "https://github.githubassets.com/images/icons/emoji/unicode/1f375.png?v8", "teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3eb.png?v8", "teapot": "https://github.githubassets.com/images/icons/emoji/unicode/1fad6.png?v8", "technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bb.png?v8", "teddy_bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f8.png?v8", "telephone": "https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8", "telephone_receiver": "https://github.githubassets.com/images/icons/emoji/unicode/1f4de.png?v8", "telescope": "https://github.githubassets.com/images/icons/emoji/unicode/1f52d.png?v8", "tennis": "https://github.githubassets.com/images/icons/emoji/unicode/1f3be.png?v8", "tent": "https://github.githubassets.com/images/icons/emoji/unicode/26fa.png?v8", "test_tube": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ea.png?v8", "thailand": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ed.png?v8", "thermometer": "https://github.githubassets.com/images/icons/emoji/unicode/1f321.png?v8", "thinking": "https://github.githubassets.com/images/icons/emoji/unicode/1f914.png?v8", "thong_sandal": "https://github.githubassets.com/images/icons/emoji/unicode/1fa74.png?v8", "thought_balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ad.png?v8", "thread": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f5.png?v8", "three": "https://github.githubassets.com/images/icons/emoji/unicode/0033-20e3.png?v8", "thumbsdown": "https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8", "thumbsup": "https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8", "ticket": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ab.png?v8", "tickets": "https://github.githubassets.com/images/icons/emoji/unicode/1f39f.png?v8", "tiger": "https://github.githubassets.com/images/icons/emoji/unicode/1f42f.png?v8", "tiger2": "https://github.githubassets.com/images/icons/emoji/unicode/1f405.png?v8", "timer_clock": "https://github.githubassets.com/images/icons/emoji/unicode/23f2.png?v8", "timor_leste": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f1.png?v8", "tipping_hand_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8", "tipping_hand_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8", "tipping_hand_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8", "tired_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f62b.png?v8", "tm": "https://github.githubassets.com/images/icons/emoji/unicode/2122.png?v8", "togo": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ec.png?v8", "toilet": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bd.png?v8", "tokelau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f0.png?v8", "tokyo_tower": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fc.png?v8", "tomato": "https://github.githubassets.com/images/icons/emoji/unicode/1f345.png?v8", "tonga": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f4.png?v8", "tongue": "https://github.githubassets.com/images/icons/emoji/unicode/1f445.png?v8", "toolbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f0.png?v8", "tooth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b7.png?v8", "toothbrush": "https://github.githubassets.com/images/icons/emoji/unicode/1faa5.png?v8", "top": "https://github.githubassets.com/images/icons/emoji/unicode/1f51d.png?v8", "tophat": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a9.png?v8", "tornado": "https://github.githubassets.com/images/icons/emoji/unicode/1f32a.png?v8", "tr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f7.png?v8", "trackball": "https://github.githubassets.com/images/icons/emoji/unicode/1f5b2.png?v8", "tractor": "https://github.githubassets.com/images/icons/emoji/unicode/1f69c.png?v8", "traffic_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a5.png?v8", "train": "https://github.githubassets.com/images/icons/emoji/unicode/1f68b.png?v8", "train2": "https://github.githubassets.com/images/icons/emoji/unicode/1f686.png?v8", "tram": "https://github.githubassets.com/images/icons/emoji/unicode/1f68a.png?v8", "transgender_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-26a7.png?v8", "transgender_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/26a7.png?v8", "triangular_flag_on_post": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a9.png?v8", "triangular_ruler": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d0.png?v8", "trident": "https://github.githubassets.com/images/icons/emoji/unicode/1f531.png?v8", "trinidad_tobago": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f9.png?v8", "tristan_da_cunha": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e6.png?v8", "triumph": "https://github.githubassets.com/images/icons/emoji/unicode/1f624.png?v8", "trolleybus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68e.png?v8", "trollface": "https://github.githubassets.com/images/icons/emoji/trollface.png?v8", "trophy": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c6.png?v8", "tropical_drink": "https://github.githubassets.com/images/icons/emoji/unicode/1f379.png?v8", "tropical_fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f420.png?v8", "truck": "https://github.githubassets.com/images/icons/emoji/unicode/1f69a.png?v8", "trumpet": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ba.png?v8", "tshirt": "https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8", "tulip": "https://github.githubassets.com/images/icons/emoji/unicode/1f337.png?v8", "tumbler_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f943.png?v8", "tunisia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f3.png?v8", "turkey": "https://github.githubassets.com/images/icons/emoji/unicode/1f983.png?v8", "turkmenistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f2.png?v8", "turks_caicos_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e8.png?v8", "turtle": "https://github.githubassets.com/images/icons/emoji/unicode/1f422.png?v8", "tuvalu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fb.png?v8", "tv": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fa.png?v8", "twisted_rightwards_arrows": "https://github.githubassets.com/images/icons/emoji/unicode/1f500.png?v8", "two": "https://github.githubassets.com/images/icons/emoji/unicode/0032-20e3.png?v8", "two_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f495.png?v8", "two_men_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f46c.png?v8", "two_women_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f46d.png?v8", "u5272": "https://github.githubassets.com/images/icons/emoji/unicode/1f239.png?v8", "u5408": "https://github.githubassets.com/images/icons/emoji/unicode/1f234.png?v8", "u55b6": "https://github.githubassets.com/images/icons/emoji/unicode/1f23a.png?v8", "u6307": "https://github.githubassets.com/images/icons/emoji/unicode/1f22f.png?v8", "u6708": "https://github.githubassets.com/images/icons/emoji/unicode/1f237.png?v8", "u6709": "https://github.githubassets.com/images/icons/emoji/unicode/1f236.png?v8", "u6e80": "https://github.githubassets.com/images/icons/emoji/unicode/1f235.png?v8", "u7121": "https://github.githubassets.com/images/icons/emoji/unicode/1f21a.png?v8", "u7533": "https://github.githubassets.com/images/icons/emoji/unicode/1f238.png?v8", "u7981": "https://github.githubassets.com/images/icons/emoji/unicode/1f232.png?v8", "u7a7a": "https://github.githubassets.com/images/icons/emoji/unicode/1f233.png?v8", "uganda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ec.png?v8", "uk": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8", "ukraine": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1e6.png?v8", "umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/2614.png?v8", "unamused": "https://github.githubassets.com/images/icons/emoji/unicode/1f612.png?v8", "underage": "https://github.githubassets.com/images/icons/emoji/unicode/1f51e.png?v8", "unicorn": "https://github.githubassets.com/images/icons/emoji/unicode/1f984.png?v8", "united_arab_emirates": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ea.png?v8", "united_nations": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f3.png?v8", "unlock": "https://github.githubassets.com/images/icons/emoji/unicode/1f513.png?v8", "up": "https://github.githubassets.com/images/icons/emoji/unicode/1f199.png?v8", "upside_down_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f643.png?v8", "uruguay": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1fe.png?v8", "us": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f8.png?v8", "us_outlying_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f2.png?v8", "us_virgin_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ee.png?v8", "uzbekistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ff.png?v8", "v": "https://github.githubassets.com/images/icons/emoji/unicode/270c.png?v8", "vampire": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db.png?v8", "vampire_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2642.png?v8", "vampire_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2640.png?v8", "vanuatu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1fa.png?v8", "vatican_city": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e6.png?v8", "venezuela": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ea.png?v8", "vertical_traffic_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a6.png?v8", "vhs": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fc.png?v8", "vibration_mode": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f3.png?v8", "video_camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f9.png?v8", "video_game": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ae.png?v8", "vietnam": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1f3.png?v8", "violin": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bb.png?v8", "virgo": "https://github.githubassets.com/images/icons/emoji/unicode/264d.png?v8", "volcano": "https://github.githubassets.com/images/icons/emoji/unicode/1f30b.png?v8", "volleyball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d0.png?v8", "vomiting_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92e.png?v8", "vs": "https://github.githubassets.com/images/icons/emoji/unicode/1f19a.png?v8", "vulcan_salute": "https://github.githubassets.com/images/icons/emoji/unicode/1f596.png?v8", "waffle": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c7.png?v8", "wales": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0077-e006c-e0073-e007f.png?v8", "walking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6.png?v8", "walking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2642.png?v8", "walking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2640.png?v8", "wallis_futuna": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1eb.png?v8", "waning_crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f318.png?v8", "waning_gibbous_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f316.png?v8", "warning": "https://github.githubassets.com/images/icons/emoji/unicode/26a0.png?v8", "wastebasket": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d1.png?v8", "watch": "https://github.githubassets.com/images/icons/emoji/unicode/231a.png?v8", "water_buffalo": "https://github.githubassets.com/images/icons/emoji/unicode/1f403.png?v8", "water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d.png?v8", "watermelon": "https://github.githubassets.com/images/icons/emoji/unicode/1f349.png?v8", "wave": "https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png?v8", "wavy_dash": "https://github.githubassets.com/images/icons/emoji/unicode/3030.png?v8", "waxing_crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f312.png?v8", "waxing_gibbous_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8", "wc": "https://github.githubassets.com/images/icons/emoji/unicode/1f6be.png?v8", "weary": "https://github.githubassets.com/images/icons/emoji/unicode/1f629.png?v8", "wedding": "https://github.githubassets.com/images/icons/emoji/unicode/1f492.png?v8", "weight_lifting": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb.png?v8", "weight_lifting_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2642.png?v8", "weight_lifting_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2640.png?v8", "western_sahara": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ed.png?v8", "whale": "https://github.githubassets.com/images/icons/emoji/unicode/1f433.png?v8", "whale2": "https://github.githubassets.com/images/icons/emoji/unicode/1f40b.png?v8", "wheel_of_dharma": "https://github.githubassets.com/images/icons/emoji/unicode/2638.png?v8", "wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/267f.png?v8", "white_check_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2705.png?v8", "white_circle": "https://github.githubassets.com/images/icons/emoji/unicode/26aa.png?v8", "white_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3.png?v8", "white_flower": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ae.png?v8", "white_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b3.png?v8", "white_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b3.png?v8", "white_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f90d.png?v8", "white_large_square": "https://github.githubassets.com/images/icons/emoji/unicode/2b1c.png?v8", "white_medium_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fd.png?v8", "white_medium_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fb.png?v8", "white_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25ab.png?v8", "white_square_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f533.png?v8", "wilted_flower": "https://github.githubassets.com/images/icons/emoji/unicode/1f940.png?v8", "wind_chime": "https://github.githubassets.com/images/icons/emoji/unicode/1f390.png?v8", "wind_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f32c.png?v8", "window": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9f.png?v8", "wine_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f377.png?v8", "wink": "https://github.githubassets.com/images/icons/emoji/unicode/1f609.png?v8", "wolf": "https://github.githubassets.com/images/icons/emoji/unicode/1f43a.png?v8", "woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469.png?v8", "woman_artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a8.png?v8", "woman_astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f680.png?v8", "woman_beard": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2640.png?v8", "woman_cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938-2640.png?v8", "woman_cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f373.png?v8", "woman_dancing": "https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8", "woman_facepalming": "https://github.githubassets.com/images/icons/emoji/unicode/1f926-2640.png?v8", "woman_factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3ed.png?v8", "woman_farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f33e.png?v8", "woman_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f37c.png?v8", "woman_firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f692.png?v8", "woman_health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2695.png?v8", "woman_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bd.png?v8", "woman_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bc.png?v8", "woman_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935-2640.png?v8", "woman_judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2696.png?v8", "woman_juggling": "https://github.githubassets.com/images/icons/emoji/unicode/1f939-2640.png?v8", "woman_mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f527.png?v8", "woman_office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bc.png?v8", "woman_pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2708.png?v8", "woman_playing_handball": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2640.png?v8", "woman_playing_water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2640.png?v8", "woman_scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f52c.png?v8", "woman_shrugging": "https://github.githubassets.com/images/icons/emoji/unicode/1f937-2640.png?v8", "woman_singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a4.png?v8", "woman_student": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f393.png?v8", "woman_teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3eb.png?v8", "woman_technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bb.png?v8", "woman_with_headscarf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d5.png?v8", "woman_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9af.png?v8", "woman_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473-2640.png?v8", "woman_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8", "womans_clothes": "https://github.githubassets.com/images/icons/emoji/unicode/1f45a.png?v8", "womans_hat": "https://github.githubassets.com/images/icons/emoji/unicode/1f452.png?v8", "women_wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2640.png?v8", "womens": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ba.png?v8", "wood": "https://github.githubassets.com/images/icons/emoji/unicode/1fab5.png?v8", "woozy_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f974.png?v8", "world_map": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fa.png?v8", "worm": "https://github.githubassets.com/images/icons/emoji/unicode/1fab1.png?v8", "worried": "https://github.githubassets.com/images/icons/emoji/unicode/1f61f.png?v8", "wrench": "https://github.githubassets.com/images/icons/emoji/unicode/1f527.png?v8", "wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c.png?v8", "writing_hand": "https://github.githubassets.com/images/icons/emoji/unicode/270d.png?v8", "x": "https://github.githubassets.com/images/icons/emoji/unicode/274c.png?v8", "yarn": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f6.png?v8", "yawning_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f971.png?v8", "yellow_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e1.png?v8", "yellow_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49b.png?v8", "yellow_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e8.png?v8", "yemen": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1ea.png?v8", "yen": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b4.png?v8", "yin_yang": "https://github.githubassets.com/images/icons/emoji/unicode/262f.png?v8", "yo_yo": "https://github.githubassets.com/images/icons/emoji/unicode/1fa80.png?v8", "yum": "https://github.githubassets.com/images/icons/emoji/unicode/1f60b.png?v8", "zambia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1f2.png?v8", "zany_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92a.png?v8", "zap": "https://github.githubassets.com/images/icons/emoji/unicode/26a1.png?v8", "zebra": "https://github.githubassets.com/images/icons/emoji/unicode/1f993.png?v8", "zero": "https://github.githubassets.com/images/icons/emoji/unicode/0030-20e3.png?v8", "zimbabwe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1fc.png?v8", "zipper_mouth_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f910.png?v8", "zombie": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df.png?v8", "zombie_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8", "zombie_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8", "zzz": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8" }, "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } ], "previews": [], "descriptionHTML": "Lists all the emojis available to use on GitHub.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "emojis" } ] }, "enterprise-admin": { "admin-stats": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprise-installation/{enterprise_or_org}/server-statistics", "title": "Get GitHub Enterprise Server statistics", "category": "enterprise-admin", "subcategory": "admin-stats", "parameters": [ { "name": "enterprise_or_org", "description": "The slug version of the enterprise name or the login of an organization.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date_start", "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_end", "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise_or_org": "ENTERPRISE_OR_ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "server_id": "ea6088f3-f095-4bf2-8d7f-c573819e8768", "collection_date": "2021-12-14T23:59:59Z", "schema_version": "20220111", "ghes_version": "3.5.0", "host_name": "github.example.com", "github_connect": { "features_enabled": [ "license_usage_sync", "content_analysis", "content_analysis_notifications" ] }, "ghe_stats": { "comments": { "total_commit_comments": 1000, "total_gist_comments": 1000, "total_issue_comments": 0, "total_pull_request_comments": 0 }, "gists": { "total_gists": 100, "private_gists": 59, "public_gists": 41 }, "hooks": { "total_hooks": 2, "active_hooks": 1, "inactive_hooks": 1 }, "issues": { "total_issues": 3421, "open_issues": 1234, "closed_issues": 1222 }, "milestones": { "total_milestones": 50, "open_milestones": 20, "closed_milestones": 30 }, "orgs": { "total_orgs": 100, "disabled_orgs": 22, "total_teams": 299, "total_team_members": 400 }, "pages": { "total_pages": 10 }, "pulls": { "total_pulls": 1232, "merged_pulls": 223, "mergeable_pulls": 435, "unmergeable_pulls": 0 }, "repos": { "total_repos": 12, "root_repos": 1, "fork_repos": 2, "org_repos": 1, "total_pushes": 42, "total_wikis": 1 }, "users": { "total_users": 2000, "admin_users": 299, "suspended_users": 423 } }, "dormant_users": { "total_dormant_users": 5, "dormancy_threshold": "90 days" } }, "schema": { "title": "Server Statistics Proxy Endpoint", "description": "Response of S4 Proxy endpoint that provides GHES statistics", "type": "array", "items": { "type": "object", "properties": { "server_id": { "type": "string" }, "collection_date": { "type": "string" }, "schema_version": { "type": "string" }, "ghes_version": { "type": "string" }, "host_name": { "type": "string" }, "github_connect": { "type": "object", "properties": { "features_enabled": { "type": "array", "items": { "type": "string" } } } }, "ghe_stats": { "type": "object", "properties": { "comments": { "type": "object", "properties": { "total_commit_comments": { "type": "integer" }, "total_gist_comments": { "type": "integer" }, "total_issue_comments": { "type": "integer" }, "total_pull_request_comments": { "type": "integer" } } }, "gists": { "type": "object", "properties": { "total_gists": { "type": "integer" }, "private_gists": { "type": "integer" }, "public_gists": { "type": "integer" } } }, "hooks": { "type": "object", "properties": { "total_hooks": { "type": "integer" }, "active_hooks": { "type": "integer" }, "inactive_hooks": { "type": "integer" } } }, "issues": { "type": "object", "properties": { "total_issues": { "type": "integer" }, "open_issues": { "type": "integer" }, "closed_issues": { "type": "integer" } } }, "milestones": { "type": "object", "properties": { "total_milestones": { "type": "integer" }, "open_milestones": { "type": "integer" }, "closed_milestones": { "type": "integer" } } }, "orgs": { "type": "object", "properties": { "total_orgs": { "type": "integer" }, "disabled_orgs": { "type": "integer" }, "total_teams": { "type": "integer" }, "total_team_members": { "type": "integer" } } }, "pages": { "type": "object", "properties": { "total_pages": { "type": "integer" } } }, "pulls": { "type": "object", "properties": { "total_pulls": { "type": "integer" }, "merged_pulls": { "type": "integer" }, "mergeable_pulls": { "type": "integer" }, "unmergeable_pulls": { "type": "integer" } } }, "repos": { "type": "object", "properties": { "total_repos": { "type": "integer" }, "root_repos": { "type": "integer" }, "fork_repos": { "type": "integer" }, "org_repos": { "type": "integer" }, "total_pushes": { "type": "integer" }, "total_wikis": { "type": "integer" } } }, "users": { "type": "object", "properties": { "total_users": { "type": "integer" }, "admin_users": { "type": "integer" }, "suspended_users": { "type": "integer" } } } } }, "dormant_users": { "type": "object", "properties": { "total_dormant_users": { "type": "integer" }, "dormancy_threshold": { "type": "string" } } } } } } } } ], "previews": [], "descriptionHTML": "Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days.
\nTo use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see \"Enabling Server Statistics for your enterprise\" in the GitHub Enterprise Server documentation.
\nYou'll need to use a personal access token:
\n- \n
- If you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics, you'll need a personal access token with the
read:enterprisepermission. \n - If you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics, you'll need a personal access token with the
read:orgpermission. \n
For more information on creating a personal access token, see \"Creating a personal access token.\"
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ], "audit-log": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/audit-log", "title": "Get the audit log for an enterprise", "category": "enterprise-admin", "subcategory": "audit-log", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "phrase", "description": "A search phrase. For more information, see Searching the audit log.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "description": "The event types to include:
\n- \n
web- returns web (non-Git) events. \ngit- returns Git events. \nall- returns both web and Git events. \n
The default is web.
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "before", "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "description": "The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.
The default is desc.
Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "@timestamp": 1606929874512, "action": "team.add_member", "actor": "octocat", "created_at": 1606929874512, "_document_id": "xJJFlFOhQ6b-5vaAFy9Rjw", "org": "octo-corp", "team": "octo-corp/example-team", "user": "monalisa" }, { "@timestamp": 1606507117008, "action": "org.create", "actor": "octocat", "created_at": 1606507117008, "_document_id": "Vqvg6kZ4MYqwWRKFDzlMoQ", "org": "octocat-test-org" }, { "@timestamp": 1605719148837, "action": "repo.destroy", "actor": "monalisa", "created_at": 1605719148837, "_document_id": "LwW2vpJZCDS-WUmo9Z-ifw", "org": "mona-org", "repo": "mona-org/mona-test-repo", "visibility": "private" } ], "schema": { "type": "array", "items": { "type": "object", "properties": { "@timestamp": { "type": "integer", "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." }, "action": { "type": "string", "description": "The name of the action that was performed, for example `user.login` or `repo.create`." }, "active": { "type": "boolean" }, "active_was": { "type": "boolean" }, "actor": { "type": "string", "description": "The actor who performed the action." }, "actor_id": { "type": "integer", "description": "The id of the actor who performed the action." }, "actor_location": { "type": "object", "properties": { "country_name": { "type": "string" } } }, "data": { "type": "object", "additionalProperties": true }, "org_id": { "type": "integer" }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." }, "business": { "type": "string" }, "config": { "type": "array", "items": { "type": "object" } }, "config_was": { "type": "array", "items": { "type": "object" } }, "content_type": { "type": "string" }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." }, "deploy_key_fingerprint": { "type": "string" }, "_document_id": { "type": "string", "description": "A unique identifier for an audit event." }, "emoji": { "type": "string" }, "events": { "type": "array", "items": { "type": "object" } }, "events_were": { "type": "array", "items": { "type": "object" } }, "explanation": { "type": "string" }, "fingerprint": { "type": "string" }, "hook_id": { "type": "integer" }, "limited_availability": { "type": "boolean" }, "message": { "type": "string" }, "name": { "type": "string" }, "old_user": { "type": "string" }, "openssh_public_key": { "type": "string" }, "org": { "type": "string" }, "previous_visibility": { "type": "string" }, "read_only": { "type": "boolean" }, "repo": { "type": "string", "description": "The name of the repository." }, "repository": { "type": "string", "description": "The name of the repository." }, "repository_public": { "type": "boolean" }, "target_login": { "type": "string" }, "team": { "type": "string" }, "transport_protocol": { "type": "integer", "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." }, "transport_protocol_name": { "type": "string", "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." }, "user": { "type": "string", "description": "The user that was affected by the action performed (if available)." }, "visibility": { "type": "string", "description": "The repository visibility, for example `public` or `private`." } } } } } } ], "previews": [], "descriptionHTML": "Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the admin:enterprise scope.
OK
" } ] } ], "billing": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/settings/billing/actions", "title": "Get GitHub Actions billing for an enterprise", "category": "enterprise-admin", "subcategory": "billing", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_minutes_used": 305, "total_paid_minutes_used": 0, "included_minutes": 3000, "minutes_used_breakdown": { "UBUNTU": 205, "MACOS": 10, "WINDOWS": 90 } }, "schema": { "type": "object", "properties": { "total_minutes_used": { "type": "integer", "description": "The sum of the free and paid GitHub Actions minutes used." }, "total_paid_minutes_used": { "type": "integer", "description": "The total paid GitHub Actions minutes used." }, "included_minutes": { "type": "integer", "description": "The amount of free GitHub Actions minutes available." }, "minutes_used_breakdown": { "type": "object", "properties": { "UBUNTU": { "type": "integer", "description": "Total minutes used on Ubuntu runner machines." }, "MACOS": { "type": "integer", "description": "Total minutes used on macOS runner machines." }, "WINDOWS": { "type": "integer", "description": "Total minutes used on Windows runner machines." }, "ubuntu_4_core": { "type": "integer", "description": "Total minutes used on Ubuntu 4 core runner machines." }, "ubuntu_8_core": { "type": "integer", "description": "Total minutes used on Ubuntu 8 core runner machines." }, "ubuntu_16_core": { "type": "integer", "description": "Total minutes used on Ubuntu 16 core runner machines." }, "ubuntu_32_core": { "type": "integer", "description": "Total minutes used on Ubuntu 32 core runner machines." }, "ubuntu_64_core": { "type": "integer", "description": "Total minutes used on Ubuntu 64 core runner machines." }, "windows_4_core": { "type": "integer", "description": "Total minutes used on Windows 4 core runner machines." }, "windows_8_core": { "type": "integer", "description": "Total minutes used on Windows 8 core runner machines." }, "windows_16_core": { "type": "integer", "description": "Total minutes used on Windows 16 core runner machines." }, "windows_32_core": { "type": "integer", "description": "Total minutes used on Windows 32 core runner machines." }, "windows_64_core": { "type": "integer", "description": "Total minutes used on Windows 64 core runner machines." }, "total": { "type": "integer", "description": "Total minutes used on all runner machines." } } } }, "required": [ "total_minutes_used", "total_paid_minutes_used", "included_minutes", "minutes_used_breakdown" ] } } } ], "previews": [], "descriptionHTML": "Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nThe authenticated user must be an enterprise admin.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/settings/billing/advanced-security", "title": "Get GitHub Advanced Security active committers for an enterprise", "category": "enterprise-admin", "subcategory": "billing", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Success
", "example": { "total_advanced_security_committers": 2, "total_count": 2, "repositories": [ { "name": "octocat-org/Hello-World", "advanced_security_committers": 2, "advanced_security_committers_breakdown": [ { "user_login": "octocat", "last_pushed_date": "2021-11-03" }, { "user_login": "octokitten", "last_pushed_date": "2021-10-25" } ] }, { "name": "octocat-org/server", "advanced_security_committers": 1, "advanced_security_committers_breakdown": [ { "user_login": "octokitten", "last_pushed_date": "2021-10-26" } ] } ] }, "schema": { "type": "object", "properties": { "total_advanced_security_committers": { "type": "integer", "examples": [ 25 ] }, "total_count": { "type": "integer", "examples": [ 2 ] }, "repositories": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "advanced_security_committers": { "type": "integer", "examples": [ 25 ] }, "advanced_security_committers_breakdown": { "type": "array", "items": { "type": "object", "properties": { "user_login": { "type": "string" }, "last_pushed_date": { "type": "string", "examples": [ "2021-11-03" ] } }, "required": [ "user_login", "last_pushed_date" ] } } }, "required": [ "name", "advanced_security_committers", "advanced_security_committers_breakdown" ] } } }, "required": [ "repositories" ] } } } ], "previews": [], "descriptionHTML": "Gets the GitHub Advanced Security active committers for an enterprise per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.
The total number of repositories with committer information is tracked by the total_count field.
Success
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/settings/billing/packages", "title": "Get GitHub Packages billing for an enterprise", "category": "enterprise-admin", "subcategory": "billing", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, "included_gigabytes_bandwidth": 10 }, "schema": { "type": "object", "properties": { "total_gigabytes_bandwidth_used": { "type": "integer", "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." }, "total_paid_gigabytes_bandwidth_used": { "type": "integer", "description": "Total paid storage space (GB) for GitHuub Packages." }, "included_gigabytes_bandwidth": { "type": "integer", "description": "Free storage space (GB) for GitHub Packages." } }, "required": [ "total_gigabytes_bandwidth_used", "total_paid_gigabytes_bandwidth_used", "included_gigabytes_bandwidth" ] } } } ], "previews": [], "descriptionHTML": "Gets the free and paid storage used for GitHub Packages in gigabytes.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nThe authenticated user must be an enterprise admin.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/settings/billing/shared-storage", "title": "Get shared storage billing for an enterprise", "category": "enterprise-admin", "subcategory": "billing", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, "estimated_storage_for_month": 40 }, "schema": { "type": "object", "properties": { "days_left_in_billing_cycle": { "type": "integer", "description": "Numbers of days left in billing cycle." }, "estimated_paid_storage_for_month": { "type": "integer", "description": "Estimated storage space (GB) used in billing cycle." }, "estimated_storage_for_month": { "type": "integer", "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." } }, "required": [ "days_left_in_billing_cycle", "estimated_paid_storage_for_month", "estimated_storage_for_month" ] } } } ], "previews": [], "descriptionHTML": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nThe authenticated user must be an enterprise admin.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ], "license": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/consumed-licenses", "title": "List enterprise consumed licenses", "category": "enterprise-admin", "subcategory": "license", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Consumed Licenses Response
", "example": { "total_seats_consumed": 5000, "total_seats_purchased": 4500, "users": [ { "enterprise_server_emails": [ "monalisa@github.com" ], "github_com_login": "monalisa", "github_com_name": "Mona Lisa", "github_com_profile": "https://github.com/monalisa", "license_type": "enterprise", "github_com_member_roles": [ "org1:Owner", "org2:Owner" ], "github_com_enterprise_role": "owner", "visual_studio_subscription_user": false, "github_com_verified_domain_emails": [ "monalisa@github.com" ], "github_com_saml_name_id": "monalisa", "enterprise_server_user": true, "github_com_user": true, "total_user_accounts": 3, "enterprise_server_user_ids": [ "example_host_name.com:123", "example_host_name_2:222" ], "github_com_orgs_with_pending_invites": [ "org1", "org2" ], "visual_studio_subscription_email": "" }, { "enterprise_server_emails": [ "deleonjavier@example.com" ], "github_com_login": "", "github_com_name": "", "github_com_profile": "", "license_type": "enterprise", "github_com_member_roles": [], "github_com_enterprise_role": "", "visual_studio_subscription_user": false, "github_com_verified_domain_emails": [], "github_com_saml_name_id": "", "enterprise_server_user": true, "github_com_user": false, "total_user_accounts": 1, "enterprise_server_user_ids": [ "example_host_name:123" ], "github_com_orgs_with_pending_invites": [], "visual_studio_subscription_email": "" } ] }, "schema": { "title": "Enterprise Consumed Licenses", "description": "A breakdown of the licenses consumed by an enterprise.", "properties": { "total_seats_consumed": { "type": "integer" }, "total_seats_purchased": { "type": "integer" }, "users": { "type": "array", "items": { "type": "object", "properties": { "github_com_login": { "type": "string" }, "github_com_name": { "type": [ "string", "null" ] }, "github_com_profile": { "type": [ "string", "null" ] }, "license_type": { "type": "string" }, "github_com_member_roles": { "type": "array", "items": { "type": "string" } }, "github_com_enterprise_role": { "type": [ "string", "null" ] }, "visual_studio_subscription_user": { "type": "boolean" }, "github_com_verified_domain_emails": { "type": "array", "items": { "type": "string" } }, "github_com_saml_name_id": { "type": [ "string", "null" ] }, "enterprise_server_user": { "type": [ "boolean", "null" ] }, "enterprise_server_emails": { "type": "array", "items": { "type": "string" } }, "github_com_user": { "type": "boolean" }, "total_user_accounts": { "type": "integer" }, "enterprise_server_user_ids": { "type": "array", "items": { "type": "string" } }, "github_com_orgs_with_pending_invites": { "type": "array", "items": { "type": "string" } }, "visual_studio_subscription_email": { "type": [ "string", "null" ] } } } } } } } } ], "previews": [], "descriptionHTML": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the read:enterprise scope.
Consumed Licenses Response
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/license-sync-status", "title": "Get a license sync status", "category": "enterprise-admin", "subcategory": "license", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "License Sync Status Response
", "example": { "server_instances": [ { "server_id": "deadbeef1", "hostname": "github.example.com", "last_sync": { "date": "2020-01-01T00:00:00Z", "status": "success", "error": "" } }, { "server_id": "filetoffish1", "hostname": "github2.example.com", "last_sync": { "date": "2020-01-01T00:00:00Z", "status": "success", "error": "" } } ] }, "schema": { "title": "License Sync Status", "description": "Information about the status of a license sync job for an enterprise.", "properties": { "server_instances": { "type": "array", "items": { "type": "object", "properties": { "server_id": { "type": "string" }, "hostname": { "type": "string" }, "last_sync": { "type": "object", "properties": { "date": { "type": "string" }, "status": { "type": "string" }, "error": { "type": "string" } } } } } } } } } } ], "previews": [], "descriptionHTML": "Gets information about the status of a license sync job for an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the read:enterprise scope.
License Sync Status Response
" } ] } ], "scim": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/scim/v2/enterprises/{enterprise}/Groups", "title": "List provisioned SCIM groups for an enterprise", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startIndex", "description": "Used for pagination: the index of the first result to return.
", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "description": "Used for pagination: the number of results to return.
", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "filter", "description": "filter results
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "excludedAttributes", "description": "attributes to exclude
", "in": "query", "required": false, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 2, "itemsPerPage": 2, "startIndex": 1, "Resources": [ { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", "externalId": null, "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "display": "octocat@github.com" }, { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "display": "hubot@example.com" } ], "meta": { "resourceType": "Group", "created": "2020-06-09T03:10:17.000+10:00", "lastModified": "2020-06-09T03:10:17.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" } }, { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "5e75bbbb-aa1a-11ea-8644-75ff655cdddd", "externalId": null, "displayName": "octo-docs-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "display": "octocat@github.com" } ], "meta": { "resourceType": "Group", "created": "2020-06-09T16:28:01.000+10:00", "lastModified": "2020-06-09T16:28:01.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/5e75bbbb-aa1a-11ea-8644-75ff655cdddd" } } ] }, "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "totalResults": { "type": "number" }, "itemsPerPage": { "type": "number" }, "startIndex": { "type": "number" }, "Resources": { "type": "array", "items": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "displayName": { "type": "string" }, "members": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "$ref": { "type": "string" }, "display": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" }, "created": { "type": "string" }, "lastModified": { "type": "string" }, "location": { "type": "string" } } } }, "required": [ "schemas", "id" ] } } }, "required": [ "schemas", "totalResults", "itemsPerPage", "startIndex", "Resources" ] } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/scim/v2/enterprises/{enterprise}/Groups", "title": "Provision a SCIM enterprise group and invite users", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of strings", "name": "schemas", "in": "body", "description": "The SCIM schema URIs.
", "isRequired": true }, { "type": "string", "name": "displayName", "in": "body", "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to.
", "isRequired": true }, { "type": "array of objects", "name": "members", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "value", "description": "The SCIM user ID for a user.
", "isRequired": true } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" }, { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" } ] }, "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", "externalId": null, "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "display": "octocat@github.com" }, { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "display": "hubot@example.com" } ], "meta": { "resourceType": "Group", "created": "2020-06-09T03:10:17.000+10:0", "lastModified": "2020-06-09T03:10:17.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" } }, "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "displayName": { "type": "string" }, "members": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "$ref": { "type": "string" }, "display": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" }, "created": { "type": "string" }, "lastModified": { "type": "string" }, "location": { "type": "string" } } } }, "required": [ "schemas", "id" ] } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nProvision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "title": "Get SCIM provisioning information for an enterprise group", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scim_group_id", "description": "Identifier generated by the GitHub SCIM endpoint.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "excludedAttributes", "description": "Attributes to exclude.
", "in": "query", "required": false, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "scim_group_id": "SCIM_GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", "externalId": null, "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "display": "octocat@github.com" }, { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "display": "hubot@example.com" } ], "meta": { "resourceType": "Group", "created": "2020-06-09T03:10:17.000+10:0", "lastModified": "2020-06-09T03:10:17.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" } }, "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "displayName": { "type": "string" }, "members": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "$ref": { "type": "string" }, "display": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" }, "created": { "type": "string" }, "lastModified": { "type": "string" }, "location": { "type": "string" } } } }, "required": [ "schemas", "id" ] } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "title": "Set SCIM information for a provisioned enterprise group", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scim_group_id", "description": "Identifier generated by the GitHub SCIM endpoint.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of strings", "name": "schemas", "in": "body", "description": "The SCIM schema URIs.
", "isRequired": true }, { "type": "string", "name": "displayName", "in": "body", "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to.
", "isRequired": true }, { "type": "array of objects", "name": "members", "in": "body", "description": "", "childParamsGroups": [ { "type": "string", "name": "value", "description": "The SCIM user ID for a user.
", "isRequired": true } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" }, { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" } ] }, "parameters": { "enterprise": "ENTERPRISE", "scim_group_id": "SCIM_GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", "externalId": null, "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "display": "octocat@github.com" }, { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "display": "hubot@example.com" } ], "meta": { "resourceType": "Group", "created": "2020-06-09T03:10:17.000+10:0", "lastModified": "2020-06-09T03:10:17.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" } }, "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "displayName": { "type": "string" }, "members": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "$ref": { "type": "string" }, "display": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" }, "created": { "type": "string" }, "lastModified": { "type": "string" }, "location": { "type": "string" } } } }, "required": [ "schemas", "id" ] } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nReplaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "title": "Update an attribute for a SCIM enterprise group", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scim_group_id", "description": "Identifier generated by the GitHub SCIM endpoint.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of strings", "name": "schemas", "in": "body", "description": "The SCIM schema URIs.
", "isRequired": true }, { "type": "array of objects", "name": "Operations", "in": "body", "description": "Array of SCIM operations.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "op", "description": "", "isRequired": true, "enum": [ "add", "Add", "remove", "Remove", "replace", "Replace" ] }, { "type": "string", "name": "path", "description": "" }, { "type": "", "name": "value", "description": "Can be any value - string, number, array or object.
" } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op": "remove", "path": "members", "value": [ { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" } ] } ] }, "parameters": { "enterprise": "ENTERPRISE", "scim_group_id": "SCIM_GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", "externalId": null, "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "display": "octocat@github.com" } ], "meta": { "resourceType": "Group", "created": "2020-06-09T03:10:17.000+10:00", "lastModified": "2020-06-09T03:10:17.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" } }, "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "displayName": { "type": "string" }, "members": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "$ref": { "type": "string" }, "display": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" }, "created": { "type": "string" }, "lastModified": { "type": "string" }, "location": { "type": "string" } } } }, "required": [ "schemas", "id" ] } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nAllows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "title": "Delete a SCIM group from an enterprise", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scim_group_id", "description": "Identifier generated by the GitHub SCIM endpoint.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "scim_group_id": "SCIM_GROUP_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/scim/v2/enterprises/{enterprise}/Users", "title": "List SCIM provisioned identities for an enterprise", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startIndex", "description": "Used for pagination: the index of the first result to return.
", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "description": "Used for pagination: the number of results to return.
", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "filter", "description": "filter results
", "in": "query", "required": false, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 2, "itemsPerPage": 2, "startIndex": 1, "Resources": [ { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "externalId": "00dowz5dr9oSfDFRA0h7", "userName": "octocat@github.com", "name": { "givenName": "Mona", "familyName": "Octocat" }, "emails": [ { "value": "octocat@github.com", "primary": true, "type": "work" } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ], "active": true, "meta": { "resourceType": "User", "created": "2020-05-30T04:02:34.000+10:00", "lastModified": "2020-05-30T04:05:04.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" } }, { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5", "externalId": "sdfoiausdofiua", "userName": "hubot@example.com", "name": { "givenName": "hu", "familyName": "bot" }, "emails": [ { "value": "hubot@example.com", "type": "work", "primary": true } ], "groups": [], "active": true, "meta": { "resourceType": "User", "created": "2020-06-05T08:29:40.000+10:00", "lastModified": "2020-06-05T08:30:19.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5" } } ] }, "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "totalResults": { "type": "number" }, "itemsPerPage": { "type": "number" }, "startIndex": { "type": "number" }, "Resources": { "type": "array", "items": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "externalId": { "type": "string" }, "userName": { "type": "string" }, "name": { "type": "object", "properties": { "givenName": { "type": "string" }, "familyName": { "type": "string" } } }, "emails": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "primary": { "type": "boolean" }, "type": { "type": "string" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } } } }, "active": { "type": "boolean" }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" }, "created": { "type": "string" }, "lastModified": { "type": "string" }, "location": { "type": "string" } } } }, "required": [ "schemas", "id" ] } } }, "required": [ "schemas", "totalResults", "itemsPerPage", "startIndex", "Resources" ] } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nRetrieves a paginated list of all provisioned enterprise members, including pending invitations.
\nWhen a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member:
\n- \n
- When a user with a SCIM-provisioned external identity is removed from an enterprise, the account's metadata is preserved to allow the user to re-join the organization in the future. \n
- When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). \n
- When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. \n
The returned list of external identities can include an entry for a null user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:
- \n
- \n
The user is granted access by the IdP and is not a member of the GitHub enterprise.
\n \n - \n
The user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account.
\n \n - \n
After successfully authenticating with the SAML SSO IdP, the
\nnullexternal identity entry is created and the user is prompted to sign in to their GitHub account:- \n
- If the user signs in, their GitHub account is linked to this entry. \n
- If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity
nullentry remains in place. \n
\n
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/scim/v2/enterprises/{enterprise}/Users", "title": "Provision and invite a SCIM enterprise user", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of strings", "name": "schemas", "in": "body", "description": "The SCIM schema URIs.
", "isRequired": true }, { "type": "string", "name": "userName", "in": "body", "description": "The username for the user.
", "isRequired": true }, { "type": "object", "name": "name", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "givenName", "description": "The first name of the user.
", "isRequired": true }, { "type": "string", "name": "familyName", "description": "The last name of the user.
", "isRequired": true } ] }, { "type": "array of objects", "name": "emails", "in": "body", "description": "List of user emails.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "value", "description": "The email address.
", "isRequired": true }, { "type": "string", "name": "type", "description": "The type of email address.
", "isRequired": true }, { "type": "boolean", "name": "primary", "description": "Whether this email address is the primary address.
", "isRequired": true } ] }, { "type": "array of objects", "name": "groups", "in": "body", "description": "List of SCIM group IDs the user is a member of.
", "childParamsGroups": [ { "type": "string", "name": "value", "description": "" } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "userName": "mona.octocat@okta.example.com", "name": { "familyName": "Octocat", "givenName": "Mona" }, "emails": [ { "value": "mona.octocat@okta.example.com", "type": "work", "primary": true } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ] }, "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "externalId": "00dowz5dr9oSfDFRA0h7", "userName": "mona.octocat@okta.example.com", "name": { "givenName": "Mona", "familyName": "Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "type": "work", "primary": true } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" } }, "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "externalId": { "type": "string" }, "userName": { "type": "string" }, "name": { "type": "object", "properties": { "givenName": { "type": "string" }, "familyName": { "type": "string" } } }, "emails": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "type": { "type": "string" }, "primary": { "type": "boolean" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } } } }, "active": { "type": "boolean" }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" }, "created": { "type": "string" }, "lastModified": { "type": "string" }, "location": { "type": "string" } } } }, "required": [ "schemas", "id" ] } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nProvision enterprise membership for a user, and send organization invitation emails to the email address.
\nYou can optionally include the groups a user will be invited to join. If you do not provide a list of groups, the user is provisioned for the enterprise, but no organization invitation emails will be sent.
Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "title": "Get SCIM provisioning information for an enterprise user", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scim_user_id", "description": "The unique identifier of the SCIM user.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "externalId": "00dowz5dr9oSfDFRA0h7", "userName": "mona.octocat@okta.example.com", "name": { "givenName": "Mona", "familyName": "Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "type": "work", "primary": true } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" } }, "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "externalId": { "type": "string" }, "userName": { "type": "string" }, "name": { "type": "object", "properties": { "givenName": { "type": "string" }, "familyName": { "type": "string" } } }, "emails": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "type": { "type": "string" }, "primary": { "type": "boolean" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } } } }, "active": { "type": "boolean" }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" }, "created": { "type": "string" }, "lastModified": { "type": "string" }, "location": { "type": "string" } } } }, "required": [ "schemas", "id" ] } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "title": "Set SCIM information for a provisioned enterprise user", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scim_user_id", "description": "The unique identifier of the SCIM user.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of strings", "name": "schemas", "in": "body", "description": "The SCIM schema URIs.
", "isRequired": true }, { "type": "string", "name": "userName", "in": "body", "description": "The username for the user.
", "isRequired": true }, { "type": "object", "name": "name", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "givenName", "description": "The first name of the user.
", "isRequired": true }, { "type": "string", "name": "familyName", "description": "The last name of the user.
", "isRequired": true } ] }, { "type": "array of objects", "name": "emails", "in": "body", "description": "List of user emails.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "value", "description": "The email address.
", "isRequired": true }, { "type": "string", "name": "type", "description": "The type of email address.
", "isRequired": true }, { "type": "boolean", "name": "primary", "description": "Whether this email address is the primary address.
", "isRequired": true } ] }, { "type": "array of objects", "name": "groups", "in": "body", "description": "List of SCIM group IDs the user is a member of.
", "childParamsGroups": [ { "type": "string", "name": "value", "description": "" } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "userName": "mona.octocat@okta.example.com", "name": { "familyName": "Octocat", "givenName": "Mona" }, "emails": [ { "value": "mona.octocat@okta.example.com", "type": "work", "primary": true } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ] }, "parameters": { "enterprise": "ENTERPRISE", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "externalId": "00dowz5dr9oSfDFRA0h7", "userName": "mona.octocat@okta.example.com", "name": { "givenName": "Mona", "familyName": "Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "type": "work", "primary": true } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" } }, "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "externalId": { "type": "string" }, "userName": { "type": "string" }, "name": { "type": "object", "properties": { "givenName": { "type": "string" }, "familyName": { "type": "string" } } }, "emails": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "type": { "type": "string" }, "primary": { "type": "boolean" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } } } }, "active": { "type": "boolean" }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" }, "created": { "type": "string" }, "lastModified": { "type": "string" }, "location": { "type": "string" } } } }, "required": [ "schemas", "id" ] } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nReplaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nYou must at least provide the required values for the user: userName, name, and emails.
Warning: Setting active: false removes the user from the enterprise, deletes the external identity, and deletes the associated {scim_user_id}.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "title": "Update an attribute for a SCIM enterprise user", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scim_user_id", "description": "The unique identifier of the SCIM user.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of strings", "name": "schemas", "in": "body", "description": "The SCIM schema URIs.
", "isRequired": true }, { "type": "array of objects", "name": "Operations", "in": "body", "description": "Array of SCIM operations.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op": "add", "path": "emails", "value": [ { "value": "monalisa@octocat.github.com", "type": "home" } ] }, { "op": "replace", "path": "name.givenName", "value": "Monalisa" } ] }, "parameters": { "enterprise": "ENTERPRISE", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "externalId": "00dowz5dr9oSfDFRA0h7", "userName": "mona.octocat@okta.example.com", "name": { "givenName": "Monalisa", "familyName": "Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "type": "work", "primary": true }, { "value": "monalisa@octocat.github.com", "type": "home" } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" } }, "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "externalId": { "type": "string" }, "userName": { "type": "string" }, "name": { "type": "object", "properties": { "givenName": { "type": "string" }, "familyName": { "type": "string" } } }, "emails": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "type": { "type": "string" }, "primary": { "type": "boolean" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } } } }, "active": { "type": "boolean" }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" }, "created": { "type": "string" }, "lastModified": { "type": "string" }, "location": { "type": "string" } } } }, "required": [ "schemas", "id" ] } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nAllows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note: Complicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning: If you set active:false using the replace operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated :scim_user_id.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nThe slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scim_user_id", "description": "The unique identifier of the SCIM user.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ] }, "gists": { "gists": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists", "title": "List gists for the authenticated user", "category": "gists", "parameters": [ { "name": "since", "description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "files": { "hello_world.rb": { "filename": "hello_world.rb", "type": "application/x-ruby", "language": "Ruby", "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", "size": 167 } }, "public": true, "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "truncated": false } ], "schema": { "type": "array", "items": { "title": "Base Gist", "description": "Base Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/gists", "title": "Create a gist", "category": "gists", "parameters": [], "bodyParameters": [ { "type": "string", "name": "description", "in": "body", "description": "Description of the gist
" }, { "type": "object", "name": "files", "in": "body", "description": "Names and content for the files that make up the gist
", "isRequired": true, "childParamsGroups": [ { "type": "object", "name": "key", "description": "A user-defined key to represent an item in files.
Content of the file
", "isRequired": true } ] } ] }, { "type": "boolean or string", "name": "public", "in": "body", "description": "Flag indicating whether the gist is public
" } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Creating a gist", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "description": "Example of a gist", "public": false, "files": { "README.md": { "content": "Hello World" } } } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/" }, "schema": { "title": "Gist Simple", "description": "Gist Simple", "type": "object", "properties": { "forks": { "deprecated": true, "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "user": { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "company": { "type": [ "string", "null" ] }, "blog": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ] }, "twitter_username": { "type": [ "string", "null" ] }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "private_gists": { "type": "integer", "examples": [ 1 ] }, "total_private_repos": { "type": "integer", "examples": [ 2 ] }, "owned_private_repos": { "type": "integer", "examples": [ 2 ] }, "disk_usage": { "type": "integer", "examples": [ 1 ] }, "collaborators": { "type": "integer", "examples": [ 3 ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "history": { "deprecated": true, "type": [ "array", "null" ], "items": { "title": "Gist History", "description": "Gist History", "type": "object", "properties": { "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "version": { "type": "string" }, "committed_at": { "type": "string", "format": "date-time" }, "change_status": { "type": "object", "properties": { "total": { "type": "integer" }, "additions": { "type": "integer" }, "deletions": { "type": "integer" } } }, "url": { "type": "string", "format": "uri" } } } }, "fork_of": { "title": "Gist", "description": "Gist", "type": [ "object", "null" ], "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] }, "url": { "type": "string" }, "forks_url": { "type": "string" }, "commits_url": { "type": "string" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string" }, "git_push_url": { "type": "string" }, "html_url": { "type": "string" }, "files": { "type": "object", "additionalProperties": { "type": [ "object", "null" ], "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "truncated": { "type": "boolean" }, "content": { "type": "string" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "comments_url": { "type": "string" }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" } } } } } ], "previews": [], "descriptionHTML": "Allows you to add a new gist with one or more files.
\nNote: Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/public", "title": "List public gists", "category": "gists", "parameters": [ { "name": "since", "description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "files": { "hello_world.rb": { "filename": "hello_world.rb", "type": "application/x-ruby", "language": "Ruby", "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", "size": 167 } }, "public": true, "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "truncated": false } ], "schema": { "type": "array", "items": { "title": "Base Gist", "description": "Base Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "List public gists sorted by most recently updated to least recently updated.
\nNote: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/starred", "title": "List starred gists", "category": "gists", "parameters": [ { "name": "since", "description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "files": { "hello_world.rb": { "filename": "hello_world.rb", "type": "application/x-ruby", "language": "Ruby", "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", "size": 167 } }, "public": true, "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "truncated": false } ], "schema": { "type": "array", "items": { "title": "Base Gist", "description": "Base Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "List the authenticated user's starred gists:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}", "title": "Get a gist", "category": "gists", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/" }, "schema": { "title": "Gist Simple", "description": "Gist Simple", "type": "object", "properties": { "forks": { "deprecated": true, "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "user": { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "company": { "type": [ "string", "null" ] }, "blog": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ] }, "twitter_username": { "type": [ "string", "null" ] }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "private_gists": { "type": "integer", "examples": [ 1 ] }, "total_private_repos": { "type": "integer", "examples": [ 2 ] }, "owned_private_repos": { "type": "integer", "examples": [ 2 ] }, "disk_usage": { "type": "integer", "examples": [ 1 ] }, "collaborators": { "type": "integer", "examples": [ 3 ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "history": { "deprecated": true, "type": [ "array", "null" ], "items": { "title": "Gist History", "description": "Gist History", "type": "object", "properties": { "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "version": { "type": "string" }, "committed_at": { "type": "string", "format": "date-time" }, "change_status": { "type": "object", "properties": { "total": { "type": "integer" }, "additions": { "type": "integer" }, "deletions": { "type": "integer" } } }, "url": { "type": "string", "format": "uri" } } } }, "fork_of": { "title": "Gist", "description": "Gist", "type": [ "object", "null" ], "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] }, "url": { "type": "string" }, "forks_url": { "type": "string" }, "commits_url": { "type": "string" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string" }, "git_push_url": { "type": "string" }, "html_url": { "type": "string" }, "files": { "type": "object", "additionalProperties": { "type": [ "object", "null" ], "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "truncated": { "type": "boolean" }, "content": { "type": "string" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "comments_url": { "type": "string" }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" } } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden Gist
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/gists/{gist_id}", "title": "Update a gist", "category": "gists", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "description", "in": "body", "description": "Description of the gist
" }, { "type": "object", "name": "files", "in": "body", "description": "Names of files to be updated
", "childParamsGroups": [ { "type": "object", "name": "key", "description": "A user-defined key to represent an item in files.
The new content of the file
" }, { "type": "string or null", "name": "filename", "description": "The new filename for the file
" } ] } ] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Updating a gist", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "description": "An update to a gist", "files": { "README.md": { "content": "Hello World from GitHub" } } }, "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/" }, "schema": { "title": "Gist Simple", "description": "Gist Simple", "type": "object", "properties": { "forks": { "deprecated": true, "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "user": { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "company": { "type": [ "string", "null" ] }, "blog": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ] }, "twitter_username": { "type": [ "string", "null" ] }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "private_gists": { "type": "integer", "examples": [ 1 ] }, "total_private_repos": { "type": "integer", "examples": [ 2 ] }, "owned_private_repos": { "type": "integer", "examples": [ 2 ] }, "disk_usage": { "type": "integer", "examples": [ 1 ] }, "collaborators": { "type": "integer", "examples": [ 3 ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "history": { "deprecated": true, "type": [ "array", "null" ], "items": { "title": "Gist History", "description": "Gist History", "type": "object", "properties": { "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "version": { "type": "string" }, "committed_at": { "type": "string", "format": "date-time" }, "change_status": { "type": "object", "properties": { "total": { "type": "integer" }, "additions": { "type": "integer" }, "deletions": { "type": "integer" } } }, "url": { "type": "string", "format": "uri" } } } }, "fork_of": { "title": "Gist", "description": "Gist", "type": [ "object", "null" ], "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] }, "url": { "type": "string" }, "forks_url": { "type": "string" }, "commits_url": { "type": "string" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string" }, "git_push_url": { "type": "string" }, "html_url": { "type": "string" }, "files": { "type": "object", "additionalProperties": { "type": [ "object", "null" ], "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "truncated": { "type": "boolean" }, "content": { "type": "string" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "comments_url": { "type": "string" }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" } } } } } ], "previews": [], "descriptionHTML": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/gists/{gist_id}", "title": "Delete a gist", "category": "gists", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}/commits", "title": "List gist commits", "category": "gists", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f", "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "change_status": { "deletions": 0, "additions": 180, "total": 180 }, "committed_at": "2010-04-14T02:15:15Z" } ], "schema": { "type": "array", "items": { "title": "Gist Commit", "description": "Gist Commit", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f" ] }, "version": { "type": "string", "examples": [ "57a7f021a713b1c5a6a199b54cc514735d2d462f" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "change_status": { "type": "object", "properties": { "total": { "type": "integer" }, "additions": { "type": "integer" }, "deletions": { "type": "integer" } } }, "committed_at": { "type": "string", "format": "date-time", "examples": [ "2010-04-14T02:15:15Z" ] } }, "required": [ "url", "user", "version", "committed_at", "change_status" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}/forks", "title": "List gist forks", "category": "gists", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "files": { "hello_world.rb": { "filename": "hello_world.rb", "type": "application/x-ruby", "language": "Ruby", "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", "size": 167 } }, "public": true, "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 1, "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } ], "schema": { "type": "array", "items": { "title": "Gist Simple", "description": "Gist Simple", "type": "object", "properties": { "forks": { "deprecated": true, "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "user": { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "company": { "type": [ "string", "null" ] }, "blog": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ] }, "twitter_username": { "type": [ "string", "null" ] }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "private_gists": { "type": "integer", "examples": [ 1 ] }, "total_private_repos": { "type": "integer", "examples": [ 2 ] }, "owned_private_repos": { "type": "integer", "examples": [ 2 ] }, "disk_usage": { "type": "integer", "examples": [ 1 ] }, "collaborators": { "type": "integer", "examples": [ 3 ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "history": { "deprecated": true, "type": [ "array", "null" ], "items": { "title": "Gist History", "description": "Gist History", "type": "object", "properties": { "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "version": { "type": "string" }, "committed_at": { "type": "string", "format": "date-time" }, "change_status": { "type": "object", "properties": { "total": { "type": "integer" }, "additions": { "type": "integer" }, "deletions": { "type": "integer" } } }, "url": { "type": "string", "format": "uri" } } } }, "fork_of": { "title": "Gist", "description": "Gist", "type": [ "object", "null" ], "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] }, "url": { "type": "string" }, "forks_url": { "type": "string" }, "commits_url": { "type": "string" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string" }, "git_push_url": { "type": "string" }, "html_url": { "type": "string" }, "files": { "type": "object", "additionalProperties": { "type": [ "object", "null" ], "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "truncated": { "type": "boolean" }, "content": { "type": "string" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "comments_url": { "type": "string" }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" } } } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/gists/{gist_id}/forks", "title": "Fork a gist", "category": "gists", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "files": { "hello_world.rb": { "filename": "hello_world.rb", "type": "application/x-ruby", "language": "Ruby", "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", "size": 167 } }, "public": true, "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "truncated": false }, "schema": { "title": "Base Gist", "description": "Base Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}/star", "title": "Check if a gist is starred", "category": "gists", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "204", "description": "Response if gist is starred
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "Response if gist is starred
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Not Found if gist is not starred
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/gists/{gist_id}/star", "title": "Star a gist", "category": "gists", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/gists/{gist_id}/star", "title": "Unstar a gist", "category": "gists", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}/{sha}", "title": "Get a gist revision", "category": "gists", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sha", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", "sha": "SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/" }, "schema": { "title": "Gist Simple", "description": "Gist Simple", "type": "object", "properties": { "forks": { "deprecated": true, "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "user": { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "company": { "type": [ "string", "null" ] }, "blog": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ] }, "twitter_username": { "type": [ "string", "null" ] }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "private_gists": { "type": "integer", "examples": [ 1 ] }, "total_private_repos": { "type": "integer", "examples": [ 2 ] }, "owned_private_repos": { "type": "integer", "examples": [ 2 ] }, "disk_usage": { "type": "integer", "examples": [ 1 ] }, "collaborators": { "type": "integer", "examples": [ 3 ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "history": { "deprecated": true, "type": [ "array", "null" ], "items": { "title": "Gist History", "description": "Gist History", "type": "object", "properties": { "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "version": { "type": "string" }, "committed_at": { "type": "string", "format": "date-time" }, "change_status": { "type": "object", "properties": { "total": { "type": "integer" }, "additions": { "type": "integer" }, "deletions": { "type": "integer" } } }, "url": { "type": "string", "format": "uri" } } } }, "fork_of": { "title": "Gist", "description": "Gist", "type": [ "object", "null" ], "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] }, "url": { "type": "string" }, "forks_url": { "type": "string" }, "commits_url": { "type": "string" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string" }, "git_push_url": { "type": "string" }, "html_url": { "type": "string" }, "files": { "type": "object", "additionalProperties": { "type": [ "object", "null" ], "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "truncated": { "type": "boolean" }, "content": { "type": "string" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "comments_url": { "type": "string" }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" } } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/gists", "title": "List gists for a user", "category": "gists", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "since", "description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "files": { "hello_world.rb": { "filename": "hello_world.rb", "type": "application/x-ruby", "language": "Ruby", "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", "size": 167 } }, "public": true, "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "truncated": false } ], "schema": { "type": "array", "items": { "title": "Base Gist", "description": "Base Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists public gists for the specified user:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "gists" } ], "comments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}/comments", "title": "List gist comments", "category": "gists", "subcategory": "comments", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" } ], "schema": { "type": "array", "items": { "title": "Gist Comment", "description": "A comment made to a gist.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDExOkdpc3RDb21tZW50MQ==" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" ] }, "body": { "description": "The comment text.", "type": "string", "maxLength": 65535, "examples": [ "Body of the attachment" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-18T23:23:56Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-18T23:23:56Z" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] } }, "required": [ "url", "id", "node_id", "user", "body", "author_association", "created_at", "updated_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/gists/{gist_id}/comments", "title": "Create a gist comment", "category": "gists", "subcategory": "comments", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The comment text.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Creating a comment in a gist", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "This is a comment to a gist" }, "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" }, "schema": { "title": "Gist Comment", "description": "A comment made to a gist.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDExOkdpc3RDb21tZW50MQ==" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" ] }, "body": { "description": "The comment text.", "type": "string", "maxLength": 65535, "examples": [ "Body of the attachment" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-18T23:23:56Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-18T23:23:56Z" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] } }, "required": [ "url", "id", "node_id", "user", "body", "author_association", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}/comments/{comment_id}", "title": "Get a gist comment", "category": "gists", "subcategory": "comments", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" }, "schema": { "title": "Gist Comment", "description": "A comment made to a gist.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDExOkdpc3RDb21tZW50MQ==" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" ] }, "body": { "description": "The comment text.", "type": "string", "maxLength": 65535, "examples": [ "Body of the attachment" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-18T23:23:56Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-18T23:23:56Z" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] } }, "required": [ "url", "id", "node_id", "user", "body", "author_association", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden Gist
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/gists/{gist_id}/comments/{comment_id}", "title": "Update a gist comment", "category": "gists", "subcategory": "comments", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The comment text.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Updating a comment in a gist", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "This is an update to a comment in a gist" }, "parameters": { "gist_id": "GIST_ID", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" }, "schema": { "title": "Gist Comment", "description": "A comment made to a gist.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDExOkdpc3RDb21tZW50MQ==" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" ] }, "body": { "description": "The comment text.", "type": "string", "maxLength": 65535, "examples": [ "Body of the attachment" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-18T23:23:56Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-18T23:23:56Z" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] } }, "required": [ "url", "id", "node_id", "user", "body", "author_association", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/gists/{gist_id}/comments/{comment_id}", "title": "Delete a gist comment", "category": "gists", "subcategory": "comments", "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ] }, "git": { "blobs": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/blobs", "title": "Create a blob", "category": "git", "subcategory": "blobs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "content", "in": "body", "description": "The new blob's content.
", "isRequired": true }, { "type": "string", "name": "encoding", "in": "body", "description": "The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.
Response
", "example": { "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" }, "schema": { "title": "Short Blob", "description": "Short Blob", "type": "object", "properties": { "url": { "type": "string" }, "sha": { "type": "string" } }, "required": [ "url", "sha" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}", "title": "Get a blob", "category": "git", "subcategory": "blobs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "file_sha", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "file_sha": "FILE_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", "encoding": "base64", "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", "size": 19, "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg==" }, "schema": { "title": "Blob", "description": "Blob", "type": "object", "properties": { "content": { "type": "string" }, "encoding": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "sha": { "type": "string" }, "size": { "type": [ "integer", "null" ] }, "node_id": { "type": "string" }, "highlighted_content": { "type": "string" } }, "required": [ "sha", "url", "node_id", "size", "content", "encoding" ] } } } ], "previews": [], "descriptionHTML": "The content in the response will always be Base64 encoded.
Note: This API supports blobs up to 100 megabytes in size.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "commits": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/commits", "title": "Create a commit", "category": "git", "subcategory": "commits", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "message", "in": "body", "description": "The commit message
", "isRequired": true }, { "type": "string", "name": "tree", "in": "body", "description": "The SHA of the tree object this commit points to
", "isRequired": true }, { "type": "array of strings", "name": "parents", "in": "body", "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.
" }, { "type": "object", "name": "author", "in": "body", "description": "Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.
The name of the author (or committer) of the commit
", "isRequired": true }, { "type": "string", "name": "email", "description": "The email of the author (or committer) of the commit
", "isRequired": true }, { "type": "string", "name": "date", "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.
The name of the author (or committer) of the commit
" }, { "type": "string", "name": "email", "description": "The email of the author (or committer) of the commit
" }, { "type": "string", "name": "date", "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.
Response
", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", "author": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "committer": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "message": "my commit message", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132", "sha": "827efc6d56897b048c772eb4087f854f46256132" }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0", "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0", "html_url": "https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0" } ], "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null }, "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" }, "schema": { "title": "Git Commit", "description": "Low-level Git commit operations within a repository", "type": "object", "properties": { "sha": { "description": "SHA for the commit", "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "author": { "description": "Identifying information for the git-user", "type": "object", "properties": { "date": { "description": "Timestamp of the commit", "format": "date-time", "type": "string", "examples": [ "2014-08-09T08:02:04+12:00" ] }, "email": { "type": "string", "description": "Git email address of the user", "examples": [ "monalisa.octocat@example.com" ] }, "name": { "description": "Name of the git user", "type": "string", "examples": [ "Monalisa Octocat" ] } }, "required": [ "email", "name", "date" ] }, "committer": { "description": "Identifying information for the git-user", "type": "object", "properties": { "date": { "description": "Timestamp of the commit", "format": "date-time", "type": "string", "examples": [ "2014-08-09T08:02:04+12:00" ] }, "email": { "type": "string", "description": "Git email address of the user", "examples": [ "monalisa.octocat@example.com" ] }, "name": { "description": "Name of the git user", "type": "string", "examples": [ "Monalisa Octocat" ] } }, "required": [ "email", "name", "date" ] }, "message": { "description": "Message describing the purpose of the commit", "type": "string", "examples": [ "Fix #42" ] }, "tree": { "type": "object", "properties": { "sha": { "description": "SHA for the commit", "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri" } }, "required": [ "sha", "url" ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "sha": { "description": "SHA for the commit", "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "sha", "url", "html_url" ] } }, "verification": { "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "signature": { "type": [ "string", "null" ] }, "payload": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "signature", "payload" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "sha", "node_id", "url", "html_url", "author", "committer", "tree", "message", "parents", "verification" ] } } } ], "previews": [], "descriptionHTML": "Creates a new Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}", "title": "Get a commit", "category": "git", "subcategory": "commits", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "commit_sha", "description": "The SHA of the commit.
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "commit_sha": "COMMIT_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd", "author": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "committer": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "message": "added readme, because im a good github citizen", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", "sha": "691272480426f78a0138979dd3ce63b77f706feb" }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5", "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" } ], "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "schema": { "title": "Git Commit", "description": "Low-level Git commit operations within a repository", "type": "object", "properties": { "sha": { "description": "SHA for the commit", "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "author": { "description": "Identifying information for the git-user", "type": "object", "properties": { "date": { "description": "Timestamp of the commit", "format": "date-time", "type": "string", "examples": [ "2014-08-09T08:02:04+12:00" ] }, "email": { "type": "string", "description": "Git email address of the user", "examples": [ "monalisa.octocat@example.com" ] }, "name": { "description": "Name of the git user", "type": "string", "examples": [ "Monalisa Octocat" ] } }, "required": [ "email", "name", "date" ] }, "committer": { "description": "Identifying information for the git-user", "type": "object", "properties": { "date": { "description": "Timestamp of the commit", "format": "date-time", "type": "string", "examples": [ "2014-08-09T08:02:04+12:00" ] }, "email": { "type": "string", "description": "Git email address of the user", "examples": [ "monalisa.octocat@example.com" ] }, "name": { "description": "Name of the git user", "type": "string", "examples": [ "Monalisa Octocat" ] } }, "required": [ "email", "name", "date" ] }, "message": { "description": "Message describing the purpose of the commit", "type": "string", "examples": [ "Fix #42" ] }, "tree": { "type": "object", "properties": { "sha": { "description": "SHA for the commit", "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri" } }, "required": [ "sha", "url" ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "sha": { "description": "SHA for the commit", "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "sha", "url", "html_url" ] } }, "verification": { "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "signature": { "type": [ "string", "null" ] }, "payload": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "signature", "payload" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "sha", "node_id", "url", "html_url", "author", "committer", "tree", "message", "parents", "verification" ] } } } ], "previews": [], "descriptionHTML": "Gets a Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "refs": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}", "title": "List matching references", "category": "git", "subcategory": "refs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ref", "description": "ref parameter
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "ref": "refs/heads/feature-a", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=", "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a", "object": { "type": "commit", "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" } }, { "ref": "refs/heads/feature-b", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=", "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b", "object": { "type": "commit", "sha": "612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac" } } ], "schema": { "type": "array", "items": { "title": "Git Reference", "description": "Git references within a repository", "type": "object", "properties": { "ref": { "type": "string" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "object": { "type": "object", "properties": { "type": { "type": "string" }, "sha": { "description": "SHA for the reference", "type": "string", "minLength": 40, "maxLength": 40, "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri" } }, "required": [ "type", "sha", "url" ] } }, "required": [ "ref", "node_id", "url", "object" ] } } } } ], "previews": [], "descriptionHTML": "Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}", "title": "Get a reference", "category": "git", "subcategory": "refs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ref", "description": "ref parameter
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", "object": { "type": "commit", "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" } }, "schema": { "title": "Git Reference", "description": "Git references within a repository", "type": "object", "properties": { "ref": { "type": "string" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "object": { "type": "object", "properties": { "type": { "type": "string" }, "sha": { "description": "SHA for the reference", "type": "string", "minLength": 40, "maxLength": 40, "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri" } }, "required": [ "type", "sha", "url" ] } }, "required": [ "ref", "node_id", "url", "object" ] } } } ], "previews": [], "descriptionHTML": "Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/refs", "title": "Create a reference", "category": "git", "subcategory": "refs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "ref", "in": "body", "description": "The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.
The SHA1 value for this reference.
", "isRequired": true }, { "type": "string", "name": "key", "in": "body", "description": "" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "refs/heads/featureA", "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", "object": { "type": "commit", "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" } }, "schema": { "title": "Git Reference", "description": "Git references within a repository", "type": "object", "properties": { "ref": { "type": "string" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "object": { "type": "object", "properties": { "type": { "type": "string" }, "sha": { "description": "SHA for the reference", "type": "string", "minLength": 40, "maxLength": 40, "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri" } }, "required": [ "type", "sha", "url" ] } }, "required": [ "ref", "node_id", "url", "object" ] } } } ], "previews": [], "descriptionHTML": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", "title": "Update a reference", "category": "git", "subcategory": "refs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ref", "description": "The name of the fully qualified reference to update. For example, refs/heads/master. If the value doesn't start with refs and have at least two slashes, it will be rejected.
The SHA1 value to set this reference to
", "isRequired": true }, { "type": "boolean", "name": "force", "in": "body", "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.
Response
", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", "object": { "type": "commit", "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" } }, "schema": { "title": "Git Reference", "description": "Git references within a repository", "type": "object", "properties": { "ref": { "type": "string" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "object": { "type": "object", "properties": { "type": { "type": "string" }, "sha": { "description": "SHA for the reference", "type": "string", "minLength": 40, "maxLength": 40, "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri" } }, "required": [ "type", "sha", "url" ] } }, "required": [ "ref", "node_id", "url", "object" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", "title": "Delete a reference", "category": "git", "subcategory": "refs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ref", "description": "ref parameter
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "tags": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/tags", "title": "Create a tag object", "category": "git", "subcategory": "tags", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "tag", "in": "body", "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").
", "isRequired": true }, { "type": "string", "name": "message", "in": "body", "description": "The tag message.
", "isRequired": true }, { "type": "string", "name": "object", "in": "body", "description": "The SHA of the git object this is tagging.
", "isRequired": true }, { "type": "string", "name": "type", "in": "body", "description": "The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.
An object with information about the individual creating the tag.
", "childParamsGroups": [ { "type": "string", "name": "name", "description": "The name of the author of the tag
", "isRequired": true }, { "type": "string", "name": "email", "description": "The email of the author of the tag
", "isRequired": true }, { "type": "string", "name": "date", "description": "When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", "message": "initial version", "tagger": { "name": "Monalisa Octocat", "email": "octocat@github.com", "date": "2014-11-07T22:01:45Z" }, "object": { "type": "commit", "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" }, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "schema": { "title": "Git Tag", "description": "Metadata for a Git tag", "type": "object", "properties": { "node_id": { "type": "string", "examples": [ "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==" ] }, "tag": { "description": "Name of the tag", "type": "string", "examples": [ "v0.0.1" ] }, "sha": { "type": "string", "examples": [ "940bd336248efae0f9ee5bc7b2d5c985887b16ac" ] }, "url": { "description": "URL for the tag", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac" ] }, "message": { "description": "Message describing the purpose of the tag", "type": "string", "examples": [ "Initial public release" ] }, "tagger": { "type": "object", "properties": { "date": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" } }, "required": [ "date", "email", "name" ] }, "object": { "type": "object", "properties": { "sha": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "sha", "type", "url" ] }, "verification": { "title": "Verification", "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "payload": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "payload", "signature" ] } }, "required": [ "sha", "url", "node_id", "tagger", "object", "tag", "message" ] } } } ], "previews": [], "descriptionHTML": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}", "title": "Get a tag", "category": "git", "subcategory": "tags", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tag_sha", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "tag_sha": "TAG_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", "message": "initial version", "tagger": { "name": "Monalisa Octocat", "email": "octocat@github.com", "date": "2014-11-07T22:01:45Z" }, "object": { "type": "commit", "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" }, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "schema": { "title": "Git Tag", "description": "Metadata for a Git tag", "type": "object", "properties": { "node_id": { "type": "string", "examples": [ "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==" ] }, "tag": { "description": "Name of the tag", "type": "string", "examples": [ "v0.0.1" ] }, "sha": { "type": "string", "examples": [ "940bd336248efae0f9ee5bc7b2d5c985887b16ac" ] }, "url": { "description": "URL for the tag", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac" ] }, "message": { "description": "Message describing the purpose of the tag", "type": "string", "examples": [ "Initial public release" ] }, "tagger": { "type": "object", "properties": { "date": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" } }, "required": [ "date", "email", "name" ] }, "object": { "type": "object", "properties": { "sha": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "sha", "type", "url" ] }, "verification": { "title": "Verification", "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "payload": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "payload", "signature" ] } }, "required": [ "sha", "url", "node_id", "tagger", "object", "tag", "message" ] } } } ], "previews": [], "descriptionHTML": "Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "trees": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/trees", "title": "Create a tree", "category": "git", "subcategory": "trees", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of objects", "name": "tree", "in": "body", "description": "Objects (of path, mode, type, and sha) specifying a tree structure.
The file referenced in the tree.
" }, { "type": "string", "name": "mode", "description": "The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.
Either blob, tree, or commit.
The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.
Response
", "example": { "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", "tree": [ { "path": "file.rb", "mode": "100644", "type": "blob", "size": 132, "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" } ], "truncated": true }, "schema": { "title": "Git Tree", "description": "The hierarchy between files in a Git repository.", "type": "object", "properties": { "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "truncated": { "type": "boolean" }, "tree": { "description": "Objects specifying a tree structure", "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "examples": [ "test/file.rb" ] }, "mode": { "type": "string", "examples": [ "040000" ] }, "type": { "type": "string", "examples": [ "tree" ] }, "sha": { "type": "string", "examples": [ "23f6827669e43831def8a7ad935069c8bd418261" ] }, "size": { "type": "integer", "examples": [ 12 ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261" ] } } }, "examples": [ { "path": "file.rb", "mode": "100644", "type": "blob", "size": 30, "sha": "44b4fc6d56897b048c772eb4087f854f46256132", "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", "properties": { "path": { "type": "string" }, "mode": { "type": "string" }, "type": { "type": "string" }, "size": { "type": "integer" }, "sha": { "type": "string" }, "url": { "type": "string" } }, "required": [ "path", "mode", "type", "sha", "url", "size" ] } ] } }, "required": [ "sha", "url", "tree", "truncated" ] } } } ], "previews": [], "descriptionHTML": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"
\nReturns an error if you try to delete a file that does not exist.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}", "title": "Get a tree", "category": "git", "subcategory": "trees", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tree_sha", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "description": "" }, { "name": "recursive", "description": "Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in :tree_sha. For example, setting recursive to any of the following will enable returning objects or subtrees: 0, 1, \"true\", and \"false\". Omit this parameter to prevent recursively returning objects or subtrees.
Default response
", "example": { "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", "tree": [ { "path": "file.rb", "mode": "100644", "type": "blob", "size": 30, "sha": "44b4fc6d56897b048c772eb4087f854f46256132", "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" }, { "path": "subdir", "mode": "040000", "type": "tree", "sha": "f484d249c660418515fb01c2b9662073663c242e", "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e" }, { "path": "exec_file", "mode": "100755", "type": "blob", "size": 75, "sha": "45b983be36b73c0788dc9cbcb76cbb80fc7bb057", "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057" } ], "truncated": false }, "schema": { "title": "Git Tree", "description": "The hierarchy between files in a Git repository.", "type": "object", "properties": { "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "truncated": { "type": "boolean" }, "tree": { "description": "Objects specifying a tree structure", "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "examples": [ "test/file.rb" ] }, "mode": { "type": "string", "examples": [ "040000" ] }, "type": { "type": "string", "examples": [ "tree" ] }, "sha": { "type": "string", "examples": [ "23f6827669e43831def8a7ad935069c8bd418261" ] }, "size": { "type": "integer", "examples": [ 12 ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261" ] } } }, "examples": [ { "path": "file.rb", "mode": "100644", "type": "blob", "size": 30, "sha": "44b4fc6d56897b048c772eb4087f854f46256132", "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", "properties": { "path": { "type": "string" }, "mode": { "type": "string" }, "type": { "type": "string" }, "size": { "type": "integer" }, "sha": { "type": "string" }, "url": { "type": "string" } }, "required": [ "path", "mode", "type", "sha", "url", "size" ] } ] } }, "required": [ "sha", "url", "tree", "truncated" ] } } }, { "key": "response-recursively-retrieving-a-tree", "request": { "description": "Example 2: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "tree_sha": "TREE_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response recursively retrieving a tree
", "example": { "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", "tree": [ { "path": "subdir/file.txt", "mode": "100644", "type": "blob", "size": 132, "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", "url": "https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" } ], "truncated": false }, "schema": { "title": "Git Tree", "description": "The hierarchy between files in a Git repository.", "type": "object", "properties": { "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "truncated": { "type": "boolean" }, "tree": { "description": "Objects specifying a tree structure", "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "examples": [ "test/file.rb" ] }, "mode": { "type": "string", "examples": [ "040000" ] }, "type": { "type": "string", "examples": [ "tree" ] }, "sha": { "type": "string", "examples": [ "23f6827669e43831def8a7ad935069c8bd418261" ] }, "size": { "type": "integer", "examples": [ 12 ] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261" ] } } }, "examples": [ { "path": "file.rb", "mode": "100644", "type": "blob", "size": 30, "sha": "44b4fc6d56897b048c772eb4087f854f46256132", "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", "properties": { "path": { "type": "string" }, "mode": { "type": "string" }, "type": { "type": "string" }, "size": { "type": "integer" }, "sha": { "type": "string" }, "url": { "type": "string" } }, "required": [ "path", "mode", "type", "sha", "url", "size" ] } ] } }, "required": [ "sha", "url", "tree", "truncated" ] } } } ], "previews": [], "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ] }, "gitignore": { "gitignore": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gitignore/templates", "title": "Get all gitignore templates", "category": "gitignore", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ "Actionscript", "Android", "AppceleratorTitanium", "Autotools", "Bancha", "C", "C++" ], "schema": { "type": "array", "items": { "type": "string" } } } } ], "previews": [], "descriptionHTML": "List all templates available to pass as an option when creating a repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "gitignore" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gitignore/templates/{name}", "title": "Get a gitignore template", "category": "gitignore", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "name": "NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "C", "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" }, "schema": { "title": "Gitignore Template", "description": "Gitignore Template", "type": "object", "properties": { "name": { "type": "string", "examples": [ "C" ] }, "source": { "type": "string", "examples": [ "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" ] } }, "required": [ "name", "source" ] } } } ], "previews": [], "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "gitignore" } ] }, "interactions": { "orgs": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/interaction-limits", "title": "Get interaction restrictions for an organization", "category": "interactions", "subcategory": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "limit": "collaborators_only", "origin": "organization", "expires_at": "2018-08-17T04:18:39Z" }, "schema": { "anyOf": [ { "title": "Interaction Limits", "description": "Interaction limit settings.", "type": "object", "properties": { "limit": { "type": "string", "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", "enum": [ "existing_users", "contributors_only", "collaborators_only" ], "examples": [ "collaborators_only" ] }, "origin": { "type": "string", "examples": [ "repository" ] }, "expires_at": { "type": "string", "format": "date-time", "examples": [ "2018-08-17T04:18:39Z" ] } }, "required": [ "limit", "origin", "expires_at" ] }, { "type": "object", "properties": {}, "additionalProperties": false } ] } } } ], "previews": [], "descriptionHTML": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/interaction-limits", "title": "Set interaction restrictions for an organization", "category": "interactions", "subcategory": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "limit", "in": "body", "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.
", "isRequired": true, "enum": [ "existing_users", "contributors_only", "collaborators_only" ] }, { "type": "string", "name": "expiry", "in": "body", "description": "The duration of the interaction restriction. Default: one_day.
Response
", "example": { "limit": "collaborators_only", "origin": "organization", "expires_at": "2018-08-17T04:18:39Z" }, "schema": { "title": "Interaction Limits", "description": "Interaction limit settings.", "type": "object", "properties": { "limit": { "type": "string", "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", "enum": [ "existing_users", "contributors_only", "collaborators_only" ], "examples": [ "collaborators_only" ] }, "origin": { "type": "string", "examples": [ "repository" ] }, "expires_at": { "type": "string", "format": "date-time", "examples": [ "2018-08-17T04:18:39Z" ] } }, "required": [ "limit", "origin", "expires_at" ] } } } ], "previews": [], "descriptionHTML": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/interaction-limits", "title": "Remove interaction restrictions for an organization", "category": "interactions", "subcategory": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ], "repos": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/interaction-limits", "title": "Get interaction restrictions for a repository", "category": "interactions", "subcategory": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "limit": "collaborators_only", "origin": "repository", "expires_at": "2018-08-17T04:18:39Z" }, "schema": { "anyOf": [ { "title": "Interaction Limits", "description": "Interaction limit settings.", "type": "object", "properties": { "limit": { "type": "string", "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", "enum": [ "existing_users", "contributors_only", "collaborators_only" ], "examples": [ "collaborators_only" ] }, "origin": { "type": "string", "examples": [ "repository" ] }, "expires_at": { "type": "string", "format": "date-time", "examples": [ "2018-08-17T04:18:39Z" ] } }, "required": [ "limit", "origin", "expires_at" ] }, { "type": "object", "properties": {}, "additionalProperties": false } ] } } } ], "previews": [], "descriptionHTML": "Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/interaction-limits", "title": "Set interaction restrictions for a repository", "category": "interactions", "subcategory": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "limit", "in": "body", "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.
", "isRequired": true, "enum": [ "existing_users", "contributors_only", "collaborators_only" ] }, { "type": "string", "name": "expiry", "in": "body", "description": "The duration of the interaction restriction. Default: one_day.
Response
", "example": { "limit": "collaborators_only", "origin": "repository", "expires_at": "2018-08-17T04:18:39Z" }, "schema": { "title": "Interaction Limits", "description": "Interaction limit settings.", "type": "object", "properties": { "limit": { "type": "string", "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", "enum": [ "existing_users", "contributors_only", "collaborators_only" ], "examples": [ "collaborators_only" ] }, "origin": { "type": "string", "examples": [ "repository" ] }, "expires_at": { "type": "string", "format": "date-time", "examples": [ "2018-08-17T04:18:39Z" ] } }, "required": [ "limit", "origin", "expires_at" ] } } } ], "previews": [], "descriptionHTML": "Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.
OK
" }, { "httpStatusCode": "409", "description": "Conflict
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/interaction-limits", "title": "Remove interaction restrictions for a repository", "category": "interactions", "subcategory": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.
No Content
" }, { "httpStatusCode": "409", "description": "Conflict
" } ] } ], "user": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/interaction-limits", "title": "Get interaction restrictions for your public repositories", "category": "interactions", "subcategory": "user", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Default response
", "example": { "limit": "collaborators_only", "origin": "organization", "expires_at": "2018-08-17T04:18:39Z" }, "schema": { "anyOf": [ { "title": "Interaction Limits", "description": "Interaction limit settings.", "type": "object", "properties": { "limit": { "type": "string", "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", "enum": [ "existing_users", "contributors_only", "collaborators_only" ], "examples": [ "collaborators_only" ] }, "origin": { "type": "string", "examples": [ "repository" ] }, "expires_at": { "type": "string", "format": "date-time", "examples": [ "2018-08-17T04:18:39Z" ] } }, "required": [ "limit", "origin", "expires_at" ] }, { "type": "object", "properties": {}, "additionalProperties": false } ] } } } ], "previews": [], "descriptionHTML": "Shows which type of GitHub user can interact with your public repositories and when the restriction expires.
", "statusCodes": [ { "httpStatusCode": "200", "description": "Default response
" }, { "httpStatusCode": "204", "description": "Response when there are no restrictions
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/interaction-limits", "title": "Set interaction restrictions for your public repositories", "category": "interactions", "subcategory": "user", "parameters": [], "bodyParameters": [ { "type": "string", "name": "limit", "in": "body", "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.
", "isRequired": true, "enum": [ "existing_users", "contributors_only", "collaborators_only" ] }, { "type": "string", "name": "expiry", "in": "body", "description": "The duration of the interaction restriction. Default: one_day.
Response
", "example": { "limit": "collaborators_only", "origin": "user", "expires_at": "2018-08-17T04:18:39Z" }, "schema": { "title": "Interaction Limits", "description": "Interaction limit settings.", "type": "object", "properties": { "limit": { "type": "string", "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", "enum": [ "existing_users", "contributors_only", "collaborators_only" ], "examples": [ "collaborators_only" ] }, "origin": { "type": "string", "examples": [ "repository" ] }, "expires_at": { "type": "string", "format": "date-time", "examples": [ "2018-08-17T04:18:39Z" ] } }, "required": [ "limit", "origin", "expires_at" ] } } } ], "previews": [], "descriptionHTML": "Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/interaction-limits", "title": "Remove interaction restrictions from your public repositories", "category": "interactions", "subcategory": "user", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes any interaction restrictions from your public repositories.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ] }, "issues": { "issues": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/issues", "title": "List issues assigned to the authenticated user", "category": "issues", "parameters": [ { "name": "filter", "description": "Indicates which sorts of issues to return. assigned means issues assigned to you. created means issues created by you. mentioned means issues mentioning you. subscribed means issues you're subscribed to updates for. all or repos means all issues you can see, regardless of participation or creation.
Indicates the state of the issues to return. Can be either open, closed, or all.
A list of comma separated label names. Example: bug,ui,@high
What to sort results by. Can be either created, updated, comments.
The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "since", "description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDU6SXNzdWUx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "repository_url": "https://api.github.com/repos/octocat/Hello-World", "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", "html_url": "https://github.com/octocat/Hello-World/issues/1347", "number": 1347, "state": "open", "title": "Found a bug", "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "locked": true, "active_lock_reason": "too heated", "comments": 0, "pull_request": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 }, "author_association": "COLLABORATOR" } ], "schema": { "type": "array", "items": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/issues", "title": "List organization issues assigned to the authenticated user", "category": "issues", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filter", "description": "Indicates which sorts of issues to return. assigned means issues assigned to you. created means issues created by you. mentioned means issues mentioning you. subscribed means issues you're subscribed to updates for. all or repos means all issues you can see, regardless of participation or creation.
Indicates the state of the issues to return. Can be either open, closed, or all.
A list of comma separated label names. Example: bug,ui,@high
What to sort results by. Can be either created, updated, comments.
The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "since", "description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDU6SXNzdWUx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "repository_url": "https://api.github.com/repos/octocat/Hello-World", "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", "html_url": "https://github.com/octocat/Hello-World/issues/1347", "number": 1347, "state": "open", "title": "Found a bug", "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "locked": true, "active_lock_reason": "too heated", "comments": 0, "pull_request": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 }, "author_association": "COLLABORATOR" } ], "schema": { "type": "array", "items": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "List issues in an organization assigned to the authenticated user.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues", "title": "List repository issues", "category": "issues", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "milestone", "description": "If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.
Indicates the state of the issues to return. Can be either open, closed, or all.
Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.
The user that created the issue.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "mentioned", "description": "A user that's mentioned in the issue.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "labels", "description": "A list of comma separated label names. Example: bug,ui,@high
What to sort results by. Can be either created, updated, comments.
The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "since", "description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDU6SXNzdWUx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "repository_url": "https://api.github.com/repos/octocat/Hello-World", "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", "html_url": "https://github.com/octocat/Hello-World/issues/1347", "number": 1347, "state": "open", "title": "Found a bug", "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "locked": true, "active_lock_reason": "too heated", "comments": 0, "pull_request": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", "closed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "author_association": "COLLABORATOR", "state_reason": "completed" } ], "schema": { "type": "array", "items": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "List issues in a repository.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
OK
" }, { "httpStatusCode": "301", "description": "Moved permanently
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues", "title": "Create an issue", "category": "issues", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string or integer", "name": "title", "in": "body", "description": "The title of the issue.
", "isRequired": true }, { "type": "string", "name": "body", "in": "body", "description": "The contents of the issue.
" }, { "type": "string or null", "name": "assignee", "in": "body", "description": "Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.
" }, { "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", "description": "The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.
Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.
" }, { "type": "array of strings", "name": "assignees", "in": "body", "description": "Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", "body": "I'm having a problem with this.", "assignees": [ "octocat" ], "milestone": 1, "labels": [ "bug" ] }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "repository_url": "https://api.github.com/repos/octocat/Hello-World", "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", "html_url": "https://github.com/octocat/Hello-World/issues/1347", "number": 1347, "state": "open", "title": "Found a bug", "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "locked": true, "active_lock_reason": "too heated", "comments": 0, "pull_request": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", "closed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "author_association": "COLLABORATOR", "state_reason": "completed" }, "schema": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", "title": "Get an issue", "category": "issues", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "repository_url": "https://api.github.com/repos/octocat/Hello-World", "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", "html_url": "https://github.com/octocat/Hello-World/issues/1347", "number": 1347, "state": "open", "title": "Found a bug", "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "locked": true, "active_lock_reason": "too heated", "comments": 0, "pull_request": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", "closed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "author_association": "COLLABORATOR", "state_reason": "completed" }, "schema": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
OK
" }, { "httpStatusCode": "301", "description": "Moved permanently
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", "title": "Update an issue", "category": "issues", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "null or string or integer or string or integer", "name": "title", "in": "body", "description": "The title of the issue.
" }, { "type": "string or null", "name": "body", "in": "body", "description": "The contents of the issue.
" }, { "type": "string or null", "name": "assignee", "in": "body", "description": "Login for the user that this issue should be assigned to. This field is deprecated.
" }, { "type": "string", "name": "state", "in": "body", "description": "State of the issue. Either open or closed.
The reason for the current state
", "enum": [ "completed", "not_planned", "reopened", null ] }, { "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", "description": "The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.
Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.
Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.
Response
", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "repository_url": "https://api.github.com/repos/octocat/Hello-World", "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", "html_url": "https://github.com/octocat/Hello-World/issues/1347", "number": 1347, "state": "open", "title": "Found a bug", "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "locked": true, "active_lock_reason": "too heated", "comments": 0, "pull_request": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", "closed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "author_association": "COLLABORATOR", "state_reason": "completed" }, "schema": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Issue owners and users with push access can edit an issue.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "301", "description": "Moved permanently
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", "title": "Lock an issue", "category": "issues", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "lock_reason", "in": "body", "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\n* off-topic
\n* too heated
\n* resolved
\n* spam
Response
" } } ], "previews": [], "descriptionHTML": "Users with push access can lock an issue or pull request's conversation.
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", "title": "Unlock an issue", "category": "issues", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Users with push access can unlock an issue's conversation.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/issues", "title": "List user account issues assigned to the authenticated user", "category": "issues", "parameters": [ { "name": "filter", "description": "Indicates which sorts of issues to return. assigned means issues assigned to you. created means issues created by you. mentioned means issues mentioning you. subscribed means issues you're subscribed to updates for. all or repos means all issues you can see, regardless of participation or creation.
Indicates the state of the issues to return. Can be either open, closed, or all.
A list of comma separated label names. Example: bug,ui,@high
What to sort results by. Can be either created, updated, comments.
The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "since", "description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDU6SXNzdWUx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "repository_url": "https://api.github.com/repos/octocat/Hello-World", "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", "html_url": "https://github.com/octocat/Hello-World/issues/1347", "number": 1347, "state": "open", "title": "Found a bug", "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "locked": true, "active_lock_reason": "too heated", "comments": 0, "pull_request": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 }, "author_association": "COLLABORATOR" } ], "schema": { "type": "array", "items": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "List issues across owned and member repositories assigned to the authenticated user.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "issues" } ], "assignees": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees", "title": "List assignees", "category": "issues", "subcategory": "assignees", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists the available assignees for issues in a repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", "title": "Check if a user can be assigned", "category": "issues", "subcategory": "assignees", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assignee", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "assignee": "ASSIGNEE" } }, "response": { "statusCode": "204", "description": "If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.
Checks if a user has permission to be assigned to an issue in this repository.
\nIf the assignee can be assigned to issues in the repository, a 204 header with no content is returned.
Otherwise a 404 status code is returned.
If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.
Otherwise a 404 status code is returned.
The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of strings", "name": "assignees", "in": "body", "description": "Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ "hubot", "other_user" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "repository_url": "https://api.github.com/repos/octocat/Hello-World", "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", "html_url": "https://github.com/octocat/Hello-World/issues/1347", "number": 1347, "state": "open", "title": "Found a bug", "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "locked": true, "active_lock_reason": "too heated", "comments": 0, "pull_request": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", "closed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "author_association": "COLLABORATOR", "state_reason": "completed" }, "schema": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", "title": "Remove assignees from an issue", "category": "issues", "subcategory": "assignees", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of strings", "name": "assignees", "in": "body", "description": "Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ "hubot", "other_user" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "repository_url": "https://api.github.com/repos/octocat/Hello-World", "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", "html_url": "https://github.com/octocat/Hello-World/issues/1347", "number": 1347, "state": "open", "title": "Found a bug", "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "locked": true, "active_lock_reason": "too heated", "comments": 0, "pull_request": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", "closed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "author_association": "COLLABORATOR", "state_reason": "completed" }, "schema": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Removes one or more assignees from an issue.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ], "comments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments", "title": "List issue comments for a repository", "category": "issues", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sort", "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
Either asc or desc. Ignored without the sort parameter.
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" } ], "schema": { "type": "array", "items": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "By default, Issue Comments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", "title": "Get an issue comment", "category": "issues", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" }, "schema": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", "title": "Update an issue comment", "category": "issues", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The contents of the comment.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" }, "schema": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", "title": "Delete an issue comment", "category": "issues", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", "title": "List issue comments", "category": "issues", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "since", "description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" } ], "schema": { "type": "array", "items": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Issue Comments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", "title": "Create an issue comment", "category": "issues", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The contents of the comment.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" }, "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" }, "schema": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "events": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events", "title": "List issue events for a repository", "category": "issues", "subcategory": "events", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDEwOklzc3VlRXZlbnQx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", "actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "event": "closed", "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "created_at": "2011-04-14T16:00:49Z", "issue": { "id": 1, "node_id": "MDU6SXNzdWUx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "repository_url": "https://api.github.com/repos/octocat/Hello-World", "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", "html_url": "https://github.com/octocat/Hello-World/issues/1347", "number": 1347, "state": "open", "title": "Found a bug", "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "locked": true, "active_lock_reason": "too heated", "comments": 0, "pull_request": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", "author_association": "COLLABORATOR", "state_reason": "completed" } } ], "schema": { "type": "array", "items": { "title": "Issue Event", "description": "Issue Event", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEwOklzc3VlRXZlbnQx" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/events/1" ] }, "actor": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "event": { "type": "string", "examples": [ "closed" ] }, "commit_id": { "type": [ "string", "null" ], "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "commit_url": { "type": [ "string", "null" ], "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue": { "anyOf": [ { "type": "null" }, { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] } ] }, "label": { "title": "Issue Event Label", "description": "Issue Event Label", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] } }, "required": [ "name", "color" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assigner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "review_requester": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "requested_reviewer": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "requested_team": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] }, "dismissed_review": { "title": "Issue Event Dismissed Review", "type": "object", "properties": { "state": { "type": "string" }, "review_id": { "type": "integer" }, "dismissal_message": { "type": [ "string", "null" ] }, "dismissal_commit_id": { "type": [ "string", "null" ] } }, "required": [ "state", "review_id", "dismissal_message" ] }, "milestone": { "title": "Issue Event Milestone", "description": "Issue Event Milestone", "type": "object", "properties": { "title": { "type": "string" } }, "required": [ "title" ] }, "project_card": { "title": "Issue Event Project Card", "description": "Issue Event Project Card", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "url", "id", "project_url", "project_id", "column_name" ] }, "rename": { "title": "Issue Event Rename", "description": "Issue Event Rename", "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "lock_reason": { "type": [ "string", "null" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", "title": "Get an issue event", "category": "issues", "subcategory": "events", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "event_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "event_id": "EVENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDEwOklzc3VlRXZlbnQx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", "actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "event": "closed", "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "created_at": "2011-04-14T16:00:49Z", "issue": { "id": 1, "node_id": "MDU6SXNzdWUx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "repository_url": "https://api.github.com/repos/octocat/Hello-World", "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", "html_url": "https://github.com/octocat/Hello-World/issues/1347", "number": 1347, "state": "open", "title": "Found a bug", "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "locked": true, "performed_via_github_app": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] }, "comments": 0, "pull_request": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", "author_association": "COLLABORATOR", "state_reason": "completed" } }, "schema": { "title": "Issue Event", "description": "Issue Event", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEwOklzc3VlRXZlbnQx" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/events/1" ] }, "actor": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "event": { "type": "string", "examples": [ "closed" ] }, "commit_id": { "type": [ "string", "null" ], "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "commit_url": { "type": [ "string", "null" ], "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue": { "anyOf": [ { "type": "null" }, { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] } ] }, "label": { "title": "Issue Event Label", "description": "Issue Event Label", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] } }, "required": [ "name", "color" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assigner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "review_requester": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "requested_reviewer": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "requested_team": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] }, "dismissed_review": { "title": "Issue Event Dismissed Review", "type": "object", "properties": { "state": { "type": "string" }, "review_id": { "type": "integer" }, "dismissal_message": { "type": [ "string", "null" ] }, "dismissal_commit_id": { "type": [ "string", "null" ] } }, "required": [ "state", "review_id", "dismissal_message" ] }, "milestone": { "title": "Issue Event Milestone", "description": "Issue Event Milestone", "type": "object", "properties": { "title": { "type": "string" } }, "required": [ "title" ] }, "project_card": { "title": "Issue Event Project Card", "description": "Issue Event Project Card", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "url", "id", "project_url", "project_id", "column_name" ] }, "rename": { "title": "Issue Event Rename", "description": "Issue Event Rename", "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "lock_reason": { "type": [ "string", "null" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", "title": "List issue events", "category": "issues", "subcategory": "events", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDEwOklzc3VlRXZlbnQx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", "actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "event": "closed", "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "created_at": "2011-04-14T16:00:49Z", "performed_via_github_app": null, "label": { "name": "label", "color": "red" } } ], "schema": { "type": "array", "items": { "title": "Issue Event for Issue", "description": "Issue Event for Issue", "anyOf": [ { "title": "Labeled Issue Event", "description": "Labeled Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "label": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "string" } }, "required": [ "name", "color" ] } }, "required": [ "label", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Unlabeled Issue Event", "description": "Unlabeled Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "label": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "string" } }, "required": [ "name", "color" ] } }, "required": [ "label", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Assigned Issue Event", "description": "Assigned Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "assignee": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assigner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app", "assignee", "assigner" ] }, { "title": "Unassigned Issue Event", "description": "Unassigned Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "assignee": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assigner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app", "assignee", "assigner" ] }, { "title": "Milestoned Issue Event", "description": "Milestoned Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "milestone": { "type": "object", "properties": { "title": { "type": "string" } }, "required": [ "title" ] } }, "required": [ "milestone", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Demilestoned Issue Event", "description": "Demilestoned Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "milestone": { "type": "object", "properties": { "title": { "type": "string" } }, "required": [ "title" ] } }, "required": [ "milestone", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Renamed Issue Event", "description": "Renamed Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "rename": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] } }, "required": [ "rename", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Review Requested Issue Event", "description": "Review Requested Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "review_requester": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "requested_team": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] }, "requested_reviewer": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "review_requester", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Review Request Removed Issue Event", "description": "Review Request Removed Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "review_requester": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "requested_team": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] }, "requested_reviewer": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "review_requester", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Review Dismissed Issue Event", "description": "Review Dismissed Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "dismissed_review": { "type": "object", "properties": { "state": { "type": "string" }, "review_id": { "type": "integer" }, "dismissal_message": { "type": [ "string", "null" ] }, "dismissal_commit_id": { "type": "string" } }, "required": [ "state", "review_id", "dismissal_message" ] } }, "required": [ "dismissed_review", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Locked Issue Event", "description": "Locked Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "lock_reason": { "type": [ "string", "null" ], "examples": [ "\"off-topic\"" ] } }, "required": [ "lock_reason", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Added to Project Issue Event", "description": "Added to Project Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "project_card": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "id", "url", "project_id", "project_url", "column_name" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Moved Column in Project Issue Event", "description": "Moved Column in Project Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "project_card": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "id", "url", "project_id", "project_url", "column_name" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Removed from Project Issue Event", "description": "Removed from Project Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "project_card": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "id", "url", "project_id", "project_url", "column_name" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Converted Note to Issue Issue Event", "description": "Converted Note to Issue Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "project_card": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "id", "url", "project_id", "project_url", "column_name" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] } ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "410", "description": "Gone
" } ] } ], "labels": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "title": "List labels for an issue", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true }, { "id": 208045947, "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", "name": "enhancement", "description": "New feature or request", "color": "a2eeef", "default": false } ], "schema": { "type": "array", "items": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "examples": [ 208045946 ] }, "node_id": { "type": "string", "examples": [ "MDU6TGFiZWwyMDgwNDU5NDY=" ] }, "url": { "description": "URL for the label", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/labels/bug" ] }, "name": { "description": "The name of the label.", "type": "string", "examples": [ "bug" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Something isn't working" ] }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string", "examples": [ "FFFFFF" ] }, "default": { "type": "boolean", "examples": [ true ] } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "410", "description": "Gone
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "title": "Add labels to an issue", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of strings", "name": "labels", "in": "body", "description": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"
Response
", "example": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true }, { "id": 208045947, "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", "name": "enhancement", "description": "New feature or request", "color": "a2eeef", "default": false } ], "schema": { "type": "array", "items": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "examples": [ 208045946 ] }, "node_id": { "type": "string", "examples": [ "MDU6TGFiZWwyMDgwNDU5NDY=" ] }, "url": { "description": "URL for the label", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/labels/bug" ] }, "name": { "description": "The name of the label.", "type": "string", "examples": [ "bug" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Something isn't working" ] }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string", "examples": [ "FFFFFF" ] }, "default": { "type": "boolean", "examples": [ true ] } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "title": "Set labels for an issue", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of strings", "name": "labels", "in": "body", "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"
Response
", "example": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true }, { "id": 208045947, "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", "name": "enhancement", "description": "New feature or request", "color": "a2eeef", "default": false } ], "schema": { "type": "array", "items": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "examples": [ 208045946 ] }, "node_id": { "type": "string", "examples": [ "MDU6TGFiZWwyMDgwNDU5NDY=" ] }, "url": { "description": "URL for the label", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/labels/bug" ] }, "name": { "description": "The name of the label.", "type": "string", "examples": [ "bug" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Something isn't working" ] }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string", "examples": [ "FFFFFF" ] }, "default": { "type": "boolean", "examples": [ true ] } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } } } ], "previews": [], "descriptionHTML": "Removes any previous labels and sets the new labels for an issue.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "title": "Remove all labels from an issue", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "410", "description": "Gone
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", "title": "Remove a label from an issue", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER", "name": "NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "schema": { "type": "array", "items": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "examples": [ 208045946 ] }, "node_id": { "type": "string", "examples": [ "MDU6TGFiZWwyMDgwNDU5NDY=" ] }, "url": { "description": "URL for the label", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/labels/bug" ] }, "name": { "description": "The name of the label.", "type": "string", "examples": [ "bug" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Something isn't working" ] }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string", "examples": [ "FFFFFF" ] }, "default": { "type": "boolean", "examples": [ true ] } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } } } ], "previews": [], "descriptionHTML": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels", "title": "List labels for a repository", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true }, { "id": 208045947, "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", "name": "enhancement", "description": "New feature or request", "color": "a2eeef", "default": false } ], "schema": { "type": "array", "items": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "examples": [ 208045946 ] }, "node_id": { "type": "string", "examples": [ "MDU6TGFiZWwyMDgwNDU5NDY=" ] }, "url": { "description": "URL for the label", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/labels/bug" ] }, "name": { "description": "The name of the label.", "type": "string", "examples": [ "bug" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Something isn't working" ] }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string", "examples": [ "FFFFFF" ] }, "default": { "type": "boolean", "examples": [ true ] } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/labels", "title": "Create a label", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji ![\":strawberry:\"](\"https://github.githubassets.com/images/icons/emoji/unicode/1f353.png\" "\\":strawberry:\\""){kind=icon}
. For a full list of available emoji and codes, see \"Emoji cheat sheet.\"
The hexadecimal color code for the label, without the leading #.
A short description of the label. Must be 100 characters or fewer.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "bug", "description": "Something isn't working", "color": "f29513" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true }, "schema": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "examples": [ 208045946 ] }, "node_id": { "type": "string", "examples": [ "MDU6TGFiZWwyMDgwNDU5NDY=" ] }, "url": { "description": "URL for the label", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/labels/bug" ] }, "name": { "description": "The name of the label.", "type": "string", "examples": [ "bug" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Something isn't working" ] }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string", "examples": [ "FFFFFF" ] }, "default": { "type": "boolean", "examples": [ true ] } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels/{name}", "title": "Get a label", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "name": "NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true }, "schema": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "examples": [ 208045946 ] }, "node_id": { "type": "string", "examples": [ "MDU6TGFiZWwyMDgwNDU5NDY=" ] }, "url": { "description": "URL for the label", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/labels/bug" ] }, "name": { "description": "The name of the label.", "type": "string", "examples": [ "bug" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Something isn't working" ] }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string", "examples": [ "FFFFFF" ] }, "default": { "type": "boolean", "examples": [ true ] } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/labels/{name}", "title": "Update a label", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [ { "type": "string", "name": "new_name", "in": "body", "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji . For a full list of available emoji and codes, see \"Emoji cheat sheet.\"
The hexadecimal color code for the label, without the leading #.
A short description of the label. Must be 100 characters or fewer.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "bug :bug:", "description": "Small bug fix required", "color": "b01f26" }, "parameters": { "owner": "OWNER", "repo": "REPO", "name": "NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:", "name": "bug :bug:", "description": "Small bug fix required", "color": "b01f26", "default": true }, "schema": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "examples": [ 208045946 ] }, "node_id": { "type": "string", "examples": [ "MDU6TGFiZWwyMDgwNDU5NDY=" ] }, "url": { "description": "URL for the label", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/labels/bug" ] }, "name": { "description": "The name of the label.", "type": "string", "examples": [ "bug" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Something isn't working" ] }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string", "examples": [ "FFFFFF" ] }, "default": { "type": "boolean", "examples": [ true ] } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/labels/{name}", "title": "Delete a label", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "name": "NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", "title": "List labels for issues in a milestone", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "milestone_number", "description": "The number that identifies the milestone.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "milestone_number": "MILESTONE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true }, { "id": 208045947, "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", "name": "enhancement", "description": "New feature or request", "color": "a2eeef", "default": false } ], "schema": { "type": "array", "items": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "examples": [ 208045946 ] }, "node_id": { "type": "string", "examples": [ "MDU6TGFiZWwyMDgwNDU5NDY=" ] }, "url": { "description": "URL for the label", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/labels/bug" ] }, "name": { "description": "The name of the label.", "type": "string", "examples": [ "bug" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Something isn't working" ] }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string", "examples": [ "FFFFFF" ] }, "default": { "type": "boolean", "examples": [ true ] } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ], "milestones": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones", "title": "List milestones", "category": "issues", "subcategory": "milestones", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "description": "The state of the milestone. Either open, closed, or all.
What to sort results by. Either due_on or completeness.
The direction of the sort. Either asc or desc.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" } ], "schema": { "type": "array", "items": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/milestones", "title": "Create a milestone", "category": "issues", "subcategory": "milestones", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "title", "in": "body", "description": "The title of the milestone.
", "isRequired": true }, { "type": "string", "name": "state", "in": "body", "description": "The state of the milestone. Either open or closed.
A description of the milestone.
" }, { "type": "string", "name": "due_on", "in": "body", "description": "The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "schema": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", "title": "Get a milestone", "category": "issues", "subcategory": "milestones", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "milestone_number", "description": "The number that identifies the milestone.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "milestone_number": "MILESTONE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "schema": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", "title": "Update a milestone", "category": "issues", "subcategory": "milestones", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "milestone_number", "description": "The number that identifies the milestone.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "title", "in": "body", "description": "The title of the milestone.
" }, { "type": "string", "name": "state", "in": "body", "description": "The state of the milestone. Either open or closed.
A description of the milestone.
" }, { "type": "string", "name": "due_on", "in": "body", "description": "The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "schema": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", "title": "Delete a milestone", "category": "issues", "subcategory": "milestones", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "milestone_number", "description": "The number that identifies the milestone.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "milestone_number": "MILESTONE_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "timeline": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", "title": "List timeline events for an issue", "category": "issues", "subcategory": "timeline", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 6430295168, "node_id": "LOE_lADODwFebM5HwC0kzwAAAAF_RoSA", "url": "https://api.github.com/repos/github/roadmap/issues/events/6430295168", "actor": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "event": "locked", "commit_id": null, "commit_url": null, "created_at": "2022-04-13T20:49:13Z", "lock_reason": null, "performed_via_github_app": null }, { "id": 6430296748, "node_id": "LE_lADODwFebM5HwC0kzwAAAAF_Roqs", "url": "https://api.github.com/repos/github/roadmap/issues/events/6430296748", "actor": { "login": "github-product-roadmap", "id": 67656570, "node_id": "MDQ6VXNlcjY3NjU2NTcw", "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github-product-roadmap", "html_url": "https://github.com/github-product-roadmap", "followers_url": "https://api.github.com/users/github-product-roadmap/followers", "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}", "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}", "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions", "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs", "repos_url": "https://api.github.com/users/github-product-roadmap/repos", "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}", "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events", "type": "User", "site_admin": false }, "event": "labeled", "commit_id": null, "commit_url": null, "created_at": "2022-04-13T20:49:34Z", "label": { "name": "beta", "color": "99dd88" }, "performed_via_github_app": null }, { "id": 6635165802, "node_id": "RTE_lADODwFebM5HwC0kzwAAAAGLfJhq", "url": "https://api.github.com/repos/github/roadmap/issues/events/6635165802", "actor": { "login": "github-product-roadmap", "id": 67656570, "node_id": "MDQ6VXNlcjY3NjU2NTcw", "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github-product-roadmap", "html_url": "https://github.com/github-product-roadmap", "followers_url": "https://api.github.com/users/github-product-roadmap/followers", "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}", "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}", "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions", "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs", "repos_url": "https://api.github.com/users/github-product-roadmap/repos", "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}", "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events", "type": "User", "site_admin": false }, "event": "renamed", "commit_id": null, "commit_url": null, "created_at": "2022-05-18T19:29:01Z", "rename": { "from": "Secret scanning: dry-runs for enterprise-level custom patterns (cloud)", "to": "Secret scanning: dry-runs for enterprise-level custom patterns" }, "performed_via_github_app": null }, { "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857", "html_url": "https://github.com/github/roadmap/issues/493#issuecomment-1130876857", "issue_url": "https://api.github.com/repos/github/roadmap/issues/493", "id": 1130876857, "node_id": "IC_kwDODwFebM5DZ8-5", "user": { "login": "octocat", "id": 94867353, "node_id": "U_kgDOBaePmQ", "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "created_at": "2022-05-19T00:52:15Z", "updated_at": "2022-05-19T00:52:15Z", "author_association": "COLLABORATOR", "body": "🚢 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/", "reactions": { "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions", "total_count": 0, "+1": 0, "-1": 0, "laugh": 0, "hooray": 0, "confused": 0, "heart": 0, "rocket": 0, "eyes": 0 }, "performed_via_github_app": null, "event": "commented", "actor": { "login": "octocat", "id": 94867353, "node_id": "U_kgDOBaePmQ", "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true } } ], "schema": { "type": "array", "items": { "title": "Timeline Event", "description": "Timeline Event", "type": "object", "anyOf": [ { "title": "Labeled Issue Event", "description": "Labeled Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "label": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "string" } }, "required": [ "name", "color" ] } }, "required": [ "label", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Unlabeled Issue Event", "description": "Unlabeled Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "label": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "string" } }, "required": [ "name", "color" ] } }, "required": [ "label", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Milestoned Issue Event", "description": "Milestoned Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "milestone": { "type": "object", "properties": { "title": { "type": "string" } }, "required": [ "title" ] } }, "required": [ "milestone", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Demilestoned Issue Event", "description": "Demilestoned Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "milestone": { "type": "object", "properties": { "title": { "type": "string" } }, "required": [ "title" ] } }, "required": [ "milestone", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Renamed Issue Event", "description": "Renamed Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "rename": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] } }, "required": [ "rename", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Review Requested Issue Event", "description": "Review Requested Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "review_requester": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "requested_team": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] }, "requested_reviewer": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "review_requester", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Review Request Removed Issue Event", "description": "Review Request Removed Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "review_requester": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "requested_team": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] }, "requested_reviewer": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "review_requester", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Review Dismissed Issue Event", "description": "Review Dismissed Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "dismissed_review": { "type": "object", "properties": { "state": { "type": "string" }, "review_id": { "type": "integer" }, "dismissal_message": { "type": [ "string", "null" ] }, "dismissal_commit_id": { "type": "string" } }, "required": [ "state", "review_id", "dismissal_message" ] } }, "required": [ "dismissed_review", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Locked Issue Event", "description": "Locked Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "lock_reason": { "type": [ "string", "null" ], "examples": [ "\"off-topic\"" ] } }, "required": [ "lock_reason", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Added to Project Issue Event", "description": "Added to Project Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "project_card": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "id", "url", "project_id", "project_url", "column_name" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Moved Column in Project Issue Event", "description": "Moved Column in Project Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "project_card": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "id", "url", "project_id", "project_url", "column_name" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Removed from Project Issue Event", "description": "Removed from Project Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "project_card": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "id", "url", "project_id", "project_url", "column_name" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Converted Note to Issue Issue Event", "description": "Converted Note to Issue Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "project_card": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "id", "url", "project_id", "project_url", "column_name" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, { "title": "Timeline Comment Event", "description": "Timeline Comment Event", "type": "object", "properties": { "event": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "id": { "description": "Unique identifier of the issue comment", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "event", "actor", "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] }, { "title": "Timeline Cross Referenced Event", "description": "Timeline Cross Referenced Event", "type": "object", "properties": { "event": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source": { "type": "object", "properties": { "type": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/1" ] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned", null ], "examples": [ "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string", "examples": [ "Widget creation fails in Safari on OS X 10.8" ] }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] }, "examples": [ "bug", "registration" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] } } } }, "required": [ "event", "created_at", "updated_at", "source" ] }, { "title": "Timeline Committed Event", "description": "Timeline Committed Event", "type": "object", "properties": { "event": { "type": "string" }, "sha": { "description": "SHA for the commit", "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "author": { "description": "Identifying information for the git-user", "type": "object", "properties": { "date": { "description": "Timestamp of the commit", "format": "date-time", "type": "string", "examples": [ "2014-08-09T08:02:04+12:00" ] }, "email": { "type": "string", "description": "Git email address of the user", "examples": [ "monalisa.octocat@example.com" ] }, "name": { "description": "Name of the git user", "type": "string", "examples": [ "Monalisa Octocat" ] } }, "required": [ "email", "name", "date" ] }, "committer": { "description": "Identifying information for the git-user", "type": "object", "properties": { "date": { "description": "Timestamp of the commit", "format": "date-time", "type": "string", "examples": [ "2014-08-09T08:02:04+12:00" ] }, "email": { "type": "string", "description": "Git email address of the user", "examples": [ "monalisa.octocat@example.com" ] }, "name": { "description": "Name of the git user", "type": "string", "examples": [ "Monalisa Octocat" ] } }, "required": [ "email", "name", "date" ] }, "message": { "description": "Message describing the purpose of the commit", "type": "string", "examples": [ "Fix #42" ] }, "tree": { "type": "object", "properties": { "sha": { "description": "SHA for the commit", "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri" } }, "required": [ "sha", "url" ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "sha": { "description": "SHA for the commit", "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "sha", "url", "html_url" ] } }, "verification": { "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "signature": { "type": [ "string", "null" ] }, "payload": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "signature", "payload" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "sha", "node_id", "url", "html_url", "author", "committer", "tree", "message", "parents", "verification" ] }, { "title": "Timeline Reviewed Event", "description": "Timeline Reviewed Event", "type": "object", "properties": { "event": { "type": "string" }, "id": { "description": "Unique identifier of the review", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=" ] }, "user": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "body": { "description": "The text of the review.", "type": [ "string", "null" ], "examples": [ "This looks great." ] }, "state": { "type": "string", "examples": [ "CHANGES_REQUESTED" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" ] }, "pull_request_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/12" ] }, "_links": { "type": "object", "properties": { "html": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "html", "pull_request" ] }, "submitted_at": { "type": "string", "format": "date-time" }, "commit_id": { "description": "A commit SHA for the review.", "type": "string", "examples": [ "54bb654c9e6025347f57900a4a5c2313a96b8035" ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] } }, "required": [ "event", "id", "node_id", "user", "body", "state", "commit_id", "html_url", "pull_request_url", "_links", "author_association" ] }, { "title": "Timeline Line Commented Event", "description": "Timeline Line Commented Event", "type": "object", "properties": { "event": { "type": "string" }, "node_id": { "type": "string" }, "comments": { "type": "array", "items": { "title": "Pull Request Review Comment", "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", "type": "object", "properties": { "url": { "description": "URL for the pull request review comment", "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", "type": [ "integer", "null" ], "examples": [ 42 ] }, "id": { "description": "The ID of the pull request review comment.", "type": "integer", "examples": [ 1 ] }, "node_id": { "description": "The node ID of the pull request review comment.", "type": "string", "examples": [ "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" ] }, "diff_hunk": { "description": "The diff of the line that the comment refers to.", "type": "string", "examples": [ "@@ -16,33 +16,40 @@ public class Connection : IConnection..." ] }, "path": { "description": "The relative path of the file to which the comment applies.", "type": "string", "examples": [ "config/database.yaml" ] }, "position": { "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 ] }, "commit_id": { "description": "The SHA of the commit to which the comment applies.", "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "original_commit_id": { "description": "The SHA of the original commit to which the comment applies.", "type": "string", "examples": [ "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840" ] }, "in_reply_to_id": { "description": "The comment ID to reply to.", "type": "integer", "examples": [ 8 ] }, "user": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "body": { "description": "The text of the comment.", "type": "string", "examples": [ "We should probably include a check for null values here." ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "html_url": { "description": "HTML URL for the pull request review comment.", "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] }, "pull_request_url": { "description": "URL for the pull request that the review comment belongs to.", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] } }, "required": [ "href" ] }, "html": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] } }, "required": [ "href" ] } }, "required": [ "self", "html", "pull_request" ] }, "start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "original_start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "start_side": { "type": [ "string", "null" ], "description": "The side of the first line of the range for a multi-line comment.", "enum": [ "LEFT", "RIGHT", null ], "default": "RIGHT" }, "line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "side": { "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", "enum": [ "LEFT", "RIGHT" ], "default": "RIGHT", "type": "string" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "body_html": { "type": "string", "examples": [ "\"comment body
\"" ] }, "body_text": { "type": "string", "examples": [ "\"comment body\"" ] } }, "required": [ "url", "id", "node_id", "pull_request_review_id", "diff_hunk", "path", "position", "original_position", "commit_id", "original_commit_id", "user", "body", "created_at", "updated_at", "html_url", "pull_request_url", "author_association", "_links" ] } } } }, { "title": "Timeline Commit Commented Event", "description": "Timeline Commit Commented Event", "type": "object", "properties": { "event": { "type": "string" }, "node_id": { "type": "string" }, "commit_id": { "type": "string" }, "comments": { "type": "array", "items": { "title": "Commit Comment", "description": "Commit Comment", "type": "object", "properties": { "html_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "body": { "type": "string" }, "path": { "type": [ "string", "null" ] }, "position": { "type": [ "integer", "null" ] }, "line": { "type": [ "integer", "null" ] }, "commit_id": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "url", "html_url", "id", "node_id", "user", "position", "line", "path", "commit_id", "body", "author_association", "created_at", "updated_at" ] } } } }, { "title": "Timeline Assigned Issue Event", "description": "Timeline Assigned Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "assignee": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app", "assignee" ] }, { "title": "Timeline Unassigned Issue Event", "description": "Timeline Unassigned Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "assignee": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app", "assignee" ] }, { "title": "State Change Issue Event", "description": "State Change Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "state_reason": { "type": [ "string", "null" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] } ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ] } ] }, "licenses": { "licenses": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/licenses", "title": "Get all commonly used licenses", "category": "licenses", "parameters": [ { "name": "featured", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "" }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "key": "mit", "name": "MIT License", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "node_id": "MDc6TGljZW5zZW1pdA==" }, { "key": "lgpl-3.0", "name": "GNU Lesser General Public License v3.0", "spdx_id": "LGPL-3.0", "url": "https://api.github.com/licenses/lgpl-3.0", "node_id": "MDc6TGljZW5zZW1pdA==" }, { "key": "mpl-2.0", "name": "Mozilla Public License 2.0", "spdx_id": "MPL-2.0", "url": "https://api.github.com/licenses/mpl-2.0", "node_id": "MDc6TGljZW5zZW1pdA==" }, { "key": "agpl-3.0", "name": "GNU Affero General Public License v3.0", "spdx_id": "AGPL-3.0", "url": "https://api.github.com/licenses/agpl-3.0", "node_id": "MDc6TGljZW5zZW1pdA==" }, { "key": "unlicense", "name": "The Unlicense", "spdx_id": "Unlicense", "url": "https://api.github.com/licenses/unlicense", "node_id": "MDc6TGljZW5zZW1pdA==" }, { "key": "apache-2.0", "name": "Apache License 2.0", "spdx_id": "Apache-2.0", "url": "https://api.github.com/licenses/apache-2.0", "node_id": "MDc6TGljZW5zZW1pdA==" }, { "key": "gpl-3.0", "name": "GNU General Public License v3.0", "spdx_id": "GPL-3.0", "url": "https://api.github.com/licenses/gpl-3.0", "node_id": "MDc6TGljZW5zZW1pdA==" } ], "schema": { "type": "array", "items": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "licenses" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/licenses/{license}", "title": "Get a license", "category": "licenses", "parameters": [ { "name": "license", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "license": "LICENSE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key": "mit", "name": "MIT License", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "http://choosealicense.com/licenses/mit/", "description": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.", "implementation": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.", "permissions": [ "commercial-use", "modifications", "distribution", "sublicense", "private-use" ], "conditions": [ "include-copyright" ], "limitations": [ "no-liability" ], "body": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n", "featured": true }, "schema": { "title": "License", "description": "License", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "http://choosealicense.com/licenses/mit/" ] }, "description": { "type": "string", "examples": [ "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty." ] }, "implementation": { "type": "string", "examples": [ "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders." ] }, "permissions": { "type": "array", "items": { "type": "string" }, "examples": [ "commercial-use", "modifications", "distribution", "sublicense", "private-use" ] }, "conditions": { "type": "array", "items": { "type": "string" }, "examples": [ "include-copyright" ] }, "limitations": { "type": "array", "items": { "type": "string" }, "examples": [ "no-liability" ] }, "body": { "type": "string", "examples": [ "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" ] }, "featured": { "type": "boolean", "examples": [ true ] } }, "required": [ "key", "name", "url", "spdx_id", "node_id", "html_url", "description", "implementation", "permissions", "conditions", "limitations", "body", "featured" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "licenses" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/license", "title": "Get the license for a repository", "category": "licenses", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "LICENSE", "path": "LICENSE", "sha": "401c59dcc4570b954dd6d345e76199e1f4e76266", "size": 1077, "url": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master", "html_url": "https://github.com/benbalter/gman/blob/master/LICENSE", "git_url": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266", "download_url": "https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true", "type": "file", "content": "VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\n", "encoding": "base64", "_links": { "self": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master", "git": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266", "html": "https://github.com/benbalter/gman/blob/master/LICENSE" }, "license": { "key": "mit", "name": "MIT License", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "node_id": "MDc6TGljZW5zZW1pdA==" } }, "schema": { "title": "License Content", "description": "License Content", "type": "object", "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "type": { "type": "string" }, "content": { "type": "string" }, "encoding": { "type": "string" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "content", "encoding", "license" ] } } } ], "previews": [], "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nSimilar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "licenses" } ] }, "markdown": { "markdown": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/markdown", "title": "Render a Markdown document", "category": "markdown", "parameters": [], "bodyParameters": [ { "type": "string", "name": "text", "in": "body", "description": "The Markdown text to render in HTML.
", "isRequired": true }, { "type": "string", "name": "mode", "in": "body", "description": "The rendering mode. Can be either markdown or gfm.
The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.
Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "markdown" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/markdown/raw", "title": "Render a Markdown document in raw mode", "category": "markdown", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [], "previews": [], "descriptionHTML": "You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "markdown" } ] }, "meta": { "meta": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/", "title": "GitHub API Root", "category": "meta", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "current_user_url": "https://api.github.com/user", "current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}", "authorizations_url": "https://api.github.com/authorizations", "code_search_url": "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}", "commit_search_url": "https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}", "emails_url": "https://api.github.com/user/emails", "emojis_url": "https://api.github.com/emojis", "events_url": "https://api.github.com/events", "feeds_url": "https://api.github.com/feeds", "followers_url": "https://api.github.com/user/followers", "following_url": "https://api.github.com/user/following{/target}", "gists_url": "https://api.github.com/gists{/gist_id}", "hub_url": "https://api.github.com/hub", "issue_search_url": "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}", "issues_url": "https://api.github.com/issues", "keys_url": "https://api.github.com/user/keys", "label_search_url": "https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}", "notifications_url": "https://api.github.com/notifications", "organization_url": "https://api.github.com/orgs/{org}", "organization_repositories_url": "https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}", "organization_teams_url": "https://api.github.com/orgs/{org}/teams", "public_gists_url": "https://api.github.com/gists/public", "rate_limit_url": "https://api.github.com/rate_limit", "repository_url": "https://api.github.com/repos/{owner}/{repo}", "repository_search_url": "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}", "current_user_repositories_url": "https://api.github.com/user/repos{?type,page,per_page,sort}", "starred_url": "https://api.github.com/user/starred{/owner}{/repo}", "starred_gists_url": "https://api.github.com/gists/starred", "topic_search_url": "https://api.github.com/search/topics?q={query}{&page,per_page}", "user_url": "https://api.github.com/users/{user}", "user_organizations_url": "https://api.github.com/user/orgs", "user_repositories_url": "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}", "user_search_url": "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}" }, "schema": { "type": "object", "properties": { "current_user_url": { "type": "string", "format": "uri-template" }, "current_user_authorizations_html_url": { "type": "string", "format": "uri-template" }, "authorizations_url": { "type": "string", "format": "uri-template" }, "code_search_url": { "type": "string", "format": "uri-template" }, "commit_search_url": { "type": "string", "format": "uri-template" }, "emails_url": { "type": "string", "format": "uri-template" }, "emojis_url": { "type": "string", "format": "uri-template" }, "events_url": { "type": "string", "format": "uri-template" }, "feeds_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri-template" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "hub_url": { "type": "string", "format": "uri-template" }, "issue_search_url": { "type": "string", "format": "uri-template" }, "issues_url": { "type": "string", "format": "uri-template" }, "keys_url": { "type": "string", "format": "uri-template" }, "label_search_url": { "type": "string", "format": "uri-template" }, "notifications_url": { "type": "string", "format": "uri-template" }, "organization_url": { "type": "string", "format": "uri-template" }, "organization_repositories_url": { "type": "string", "format": "uri-template" }, "organization_teams_url": { "type": "string", "format": "uri-template" }, "public_gists_url": { "type": "string", "format": "uri-template" }, "rate_limit_url": { "type": "string", "format": "uri-template" }, "repository_url": { "type": "string", "format": "uri-template" }, "repository_search_url": { "type": "string", "format": "uri-template" }, "current_user_repositories_url": { "type": "string", "format": "uri-template" }, "starred_url": { "type": "string", "format": "uri-template" }, "starred_gists_url": { "type": "string", "format": "uri-template" }, "topic_search_url": { "type": "string", "format": "uri-template" }, "user_url": { "type": "string", "format": "uri-template" }, "user_organizations_url": { "type": "string", "format": "uri-template" }, "user_repositories_url": { "type": "string", "format": "uri-template" }, "user_search_url": { "type": "string", "format": "uri-template" } }, "required": [ "current_user_url", "current_user_authorizations_html_url", "authorizations_url", "code_search_url", "commit_search_url", "emails_url", "emojis_url", "events_url", "feeds_url", "followers_url", "following_url", "gists_url", "hub_url", "issue_search_url", "issues_url", "keys_url", "label_search_url", "notifications_url", "organization_url", "organization_repositories_url", "organization_teams_url", "public_gists_url", "rate_limit_url", "repository_url", "repository_search_url", "current_user_repositories_url", "starred_url", "starred_gists_url", "user_url", "user_organizations_url", "user_repositories_url", "user_search_url" ] } } } ], "previews": [], "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "meta" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/meta", "title": "Get GitHub meta information", "category": "meta", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ", "SHA256_ECDSA": "p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM", "SHA256_ED25519": "+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU" }, "ssh_keys": [ "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl", "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBEmKSENjQEezOmxkZMy7opKgwFB9nkt5YRrYMjNuG5N87uRgg6CLrbo5wAdT/y6v0mKV0U2w0WZ2YB/++Tpockg=", "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==" ], "hooks": [ "192.30.252.0/22" ], "web": [ "192.30.252.0/22", "185.199.108.0/22" ], "api": [ "192.30.252.0/22", "185.199.108.0/22" ], "git": [ "192.30.252.0/22" ], "packages": [ "192.30.252.0/22" ], "pages": [ "192.30.252.153/32", "192.30.252.154/32" ], "importer": [ "54.158.161.132", "54.226.70.38" ], "actions": [ "13.64.0.0/16", "13.65.0.0/16" ], "dependabot": [ "54.158.161.132" ] }, "schema": { "title": "Api Overview", "description": "Api Overview", "type": "object", "properties": { "verifiable_password_authentication": { "type": "boolean", "examples": [ true ] }, "ssh_key_fingerprints": { "type": "object", "properties": { "SHA256_RSA": { "type": "string" }, "SHA256_DSA": { "type": "string" }, "SHA256_ECDSA": { "type": "string" }, "SHA256_ED25519": { "type": "string" } } }, "ssh_keys": { "type": "array", "items": { "type": "string" }, "examples": [ "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl" ] }, "hooks": { "type": "array", "items": { "type": "string" }, "examples": [ "127.0.0.1/32" ] }, "web": { "type": "array", "items": { "type": "string" }, "examples": [ "127.0.0.1/32" ] }, "api": { "type": "array", "items": { "type": "string" }, "examples": [ "127.0.0.1/32" ] }, "git": { "type": "array", "items": { "type": "string" }, "examples": [ "127.0.0.1/32" ] }, "packages": { "type": "array", "items": { "type": "string" }, "examples": [ "13.65.0.0/16", "157.55.204.33/32", "2a01:111:f403:f90c::/62" ] }, "pages": { "type": "array", "items": { "type": "string" }, "examples": [ "192.30.252.153/32", "192.30.252.154/32" ] }, "importer": { "type": "array", "items": { "type": "string" }, "examples": [ "54.158.161.132", "54.226.70.38" ] }, "actions": { "type": "array", "items": { "type": "string" }, "examples": [ "13.64.0.0/16", "13.65.0.0/16" ] }, "dependabot": { "type": "array", "items": { "type": "string" }, "examples": [ "192.168.7.15/32", "192.168.7.16/32" ] } }, "required": [ "verifiable_password_authentication" ] } } } ], "previews": [], "descriptionHTML": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nNote: The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "meta" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/octocat", "title": "Get Octocat", "category": "meta", "parameters": [ { "name": "s", "in": "query", "description": "The words to show in Octocat's speech bubble
", "schema": { "type": "string" }, "required": false } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/octocat-stream", "description": "Response
", "example": " MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n", "schema": { "type": "string" } } } ], "previews": [], "descriptionHTML": "Get the octocat as ASCII art
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "meta" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/zen", "title": "Get the Zen of GitHub", "category": "meta", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "text/plain", "description": "Example response
", "example": "Responsive is better than fast", "schema": { "type": "string" } } } ], "previews": [], "descriptionHTML": "Get a random sentence from the Zen of GitHub
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "meta" } ] }, "metrics": { "community": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/community/profile", "title": "Get community profile metrics", "category": "metrics", "subcategory": "community", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "health_percentage": 100, "description": "My first repository on GitHub!", "documentation": null, "files": { "code_of_conduct": { "name": "Contributor Covenant", "key": "contributor_covenant", "url": "https://api.github.com/codes_of_conduct/contributor_covenant", "html_url": "https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md" }, "code_of_conduct_file": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/CODE_OF_CONDUCT.md", "html_url": "https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md" }, "contributing": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/CONTRIBUTING", "html_url": "https://github.com/octocat/Hello-World/blob/master/CONTRIBUTING" }, "issue_template": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/ISSUE_TEMPLATE", "html_url": "https://github.com/octocat/Hello-World/blob/master/ISSUE_TEMPLATE" }, "pull_request_template": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/PULL_REQUEST_TEMPLATE", "html_url": "https://github.com/octocat/Hello-World/blob/master/PULL_REQUEST_TEMPLATE" }, "license": { "name": "MIT License", "key": "mit", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "html_url": "https://github.com/octocat/Hello-World/blob/master/LICENSE", "node_id": "MDc6TGljZW5zZW1pdA==" }, "readme": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/README.md", "html_url": "https://github.com/octocat/Hello-World/blob/master/README.md" } }, "updated_at": "2017-02-28T19:09:29Z", "content_reports_enabled": true }, "schema": { "title": "Community Profile", "description": "Community Profile", "type": "object", "properties": { "health_percentage": { "type": "integer", "examples": [ 100 ] }, "description": { "type": [ "string", "null" ], "examples": [ "My first repository on GitHub!" ] }, "documentation": { "type": [ "string", "null" ], "examples": [ "example.com" ] }, "files": { "type": "object", "properties": { "code_of_conduct": { "anyOf": [ { "type": "null" }, { "title": "Code Of Conduct Simple", "description": "Code of Conduct Simple", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/github/docs/community/code_of_conduct" ] }, "key": { "type": "string", "examples": [ "citizen_code_of_conduct" ] }, "name": { "type": "string", "examples": [ "Citizen Code of Conduct" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" ] } }, "required": [ "url", "key", "name", "html_url" ] } ] }, "code_of_conduct_file": { "anyOf": [ { "type": "null" }, { "title": "Community Health File", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "url", "html_url" ] } ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "contributing": { "anyOf": [ { "type": "null" }, { "title": "Community Health File", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "url", "html_url" ] } ] }, "readme": { "anyOf": [ { "type": "null" }, { "title": "Community Health File", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "url", "html_url" ] } ] }, "issue_template": { "anyOf": [ { "type": "null" }, { "title": "Community Health File", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "url", "html_url" ] } ] }, "pull_request_template": { "anyOf": [ { "type": "null" }, { "title": "Community Health File", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "url", "html_url" ] } ] } }, "required": [ "code_of_conduct", "code_of_conduct_file", "license", "contributing", "readme", "issue_template", "pull_request_template" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2017-02-28T19:09:29Z" ] }, "content_reports_enabled": { "type": "boolean", "examples": [ true ] } }, "required": [ "health_percentage", "description", "documentation", "files", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "This endpoint will return all community profile metrics, including an\noverall health score, repository description, the presence of documentation, detected\ncode of conduct, detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.
\nThe health_percentage score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe health_percentage is 100. If only one is present, then the\nhealth_percentage is 25.
content_reports_enabled is only returned for organization-owned repositories.
OK
" } ] } ], "statistics": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", "title": "Get the weekly commit activity", "category": "metrics", "subcategory": "statistics", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", "example": [ [ 1302998400, 1124, -435 ] ], "schema": { "type": "array", "items": { "title": "Code Frequency Stat", "description": "Code Frequency Stat", "type": "array", "items": { "type": "integer" } } } } } ], "previews": [], "descriptionHTML": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
" }, { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "204", "description": "A header with no content is returned.
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", "title": "Get the last year of commit activity", "category": "metrics", "subcategory": "statistics", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "days": [ 0, 3, 26, 20, 39, 1, 0 ], "total": 89, "week": 1336280400 } ], "schema": { "type": "array", "items": { "title": "Commit Activity", "description": "Commit Activity", "type": "object", "properties": { "days": { "type": "array", "items": { "type": "integer" }, "examples": [ 0, 3, 26, 20, 39, 1, 0 ] }, "total": { "type": "integer", "examples": [ 89 ] }, "week": { "type": "integer", "examples": [ 1336280400 ] } }, "required": [ "days", "total", "week" ] } } } } ], "previews": [], "descriptionHTML": "Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
OK
" }, { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "204", "description": "A header with no content is returned.
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/contributors", "title": "Get all contributor commit activity", "category": "metrics", "subcategory": "statistics", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "total": 135, "weeks": [ { "w": 1367712000, "a": 6898, "d": 77, "c": 10 } ] } ], "schema": { "type": "array", "items": { "title": "Contributor Activity", "description": "Contributor Activity", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "total": { "type": "integer", "examples": [ 135 ] }, "weeks": { "type": "array", "items": { "type": "object", "properties": { "w": { "type": "integer" }, "a": { "type": "integer" }, "d": { "type": "integer" }, "c": { "type": "integer" } } }, "examples": [ { "w": "1367712000", "a": 6898, "d": 77, "c": 10 } ] } }, "required": [ "author", "total", "weeks" ] } } } } ], "previews": [], "descriptionHTML": "Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
- \n
w- Start of the week, given as a Unix timestamp. \na- Number of additions \nd- Number of deletions \nc- Number of commits \n
OK
" }, { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "204", "description": "A header with no content is returned.
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/participation", "title": "Get the weekly commit count", "category": "metrics", "subcategory": "statistics", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "The array order is oldest week (index 0) to most recent week.
", "example": { "all": [ 11, 21, 15, 2, 8, 1, 8, 23, 17, 21, 11, 10, 33, 91, 38, 34, 22, 23, 32, 3, 43, 87, 71, 18, 13, 5, 13, 16, 66, 27, 12, 45, 110, 117, 13, 8, 18, 9, 19, 26, 39, 12, 20, 31, 46, 91, 45, 10, 24, 9, 29, 7 ], "owner": [ 3, 2, 3, 0, 2, 0, 5, 14, 7, 9, 1, 5, 0, 48, 19, 2, 0, 1, 10, 2, 23, 40, 35, 8, 8, 2, 10, 6, 30, 0, 2, 9, 53, 104, 3, 3, 10, 4, 7, 11, 21, 4, 4, 22, 26, 63, 11, 2, 14, 1, 10, 3 ] }, "schema": { "title": "Participation Stats", "type": "object", "properties": { "all": { "type": "array", "items": { "type": "integer" } }, "owner": { "type": "array", "items": { "type": "integer" } } }, "required": [ "all", "owner" ] } } } ], "previews": [], "descriptionHTML": "Returns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.
The array order is oldest week (index 0) to most recent week.
", "statusCodes": [ { "httpStatusCode": "200", "description": "The array order is oldest week (index 0) to most recent week.
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/punch_card", "title": "Get the hourly commit count for each day", "category": "metrics", "subcategory": "statistics", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
Each array contains the day number, hour number, and number of commits:
\n- \n
0-6: Sunday - Saturday \n0-23: Hour of day \n- Number of commits \n
For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
A header with no content is returned.
" } ] } ], "traffic": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/traffic/clones", "title": "Get repository clones", "category": "metrics", "subcategory": "traffic", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per", "description": "The time frame to display results for.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "", "day", "week" ], "default": "day" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "count": 173, "uniques": 128, "clones": [ { "timestamp": "2016-10-10T00:00:00Z", "count": 2, "uniques": 1 }, { "timestamp": "2016-10-11T00:00:00Z", "count": 17, "uniques": 16 }, { "timestamp": "2016-10-12T00:00:00Z", "count": 21, "uniques": 15 }, { "timestamp": "2016-10-13T00:00:00Z", "count": 8, "uniques": 7 }, { "timestamp": "2016-10-14T00:00:00Z", "count": 5, "uniques": 5 }, { "timestamp": "2016-10-15T00:00:00Z", "count": 2, "uniques": 2 }, { "timestamp": "2016-10-16T00:00:00Z", "count": 8, "uniques": 7 }, { "timestamp": "2016-10-17T00:00:00Z", "count": 26, "uniques": 15 }, { "timestamp": "2016-10-18T00:00:00Z", "count": 19, "uniques": 17 }, { "timestamp": "2016-10-19T00:00:00Z", "count": 19, "uniques": 14 }, { "timestamp": "2016-10-20T00:00:00Z", "count": 19, "uniques": 15 }, { "timestamp": "2016-10-21T00:00:00Z", "count": 9, "uniques": 7 }, { "timestamp": "2016-10-22T00:00:00Z", "count": 5, "uniques": 5 }, { "timestamp": "2016-10-23T00:00:00Z", "count": 6, "uniques": 5 }, { "timestamp": "2016-10-24T00:00:00Z", "count": 7, "uniques": 5 } ] }, "schema": { "title": "Clone Traffic", "description": "Clone Traffic", "type": "object", "properties": { "count": { "type": "integer", "examples": [ 173 ] }, "uniques": { "type": "integer", "examples": [ 128 ] }, "clones": { "type": "array", "items": { "title": "Traffic", "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "uniques": { "type": "integer" }, "count": { "type": "integer" } }, "required": [ "timestamp", "uniques", "count" ] } } }, "required": [ "uniques", "count", "clones" ] } } } ], "previews": [], "descriptionHTML": "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/traffic/popular/paths", "title": "Get top referral paths", "category": "metrics", "subcategory": "traffic", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "path": "/github/hubot", "title": "github/hubot: A customizable life embetterment robot.", "count": 3542, "uniques": 2225 }, { "path": "/github/hubot/blob/master/docs/scripting.md", "title": "hubot/scripting.md at master · github/hubot · GitHub", "count": 1707, "uniques": 804 }, { "path": "/github/hubot/tree/master/docs", "title": "hubot/docs at master · github/hubot · GitHub", "count": 685, "uniques": 435 }, { "path": "/github/hubot/tree/master/src", "title": "hubot/src at master · github/hubot · GitHub", "count": 577, "uniques": 347 }, { "path": "/github/hubot/blob/master/docs/index.md", "title": "hubot/index.md at master · github/hubot · GitHub", "count": 379, "uniques": 259 }, { "path": "/github/hubot/blob/master/docs/adapters.md", "title": "hubot/adapters.md at master · github/hubot · GitHub", "count": 354, "uniques": 201 }, { "path": "/github/hubot/tree/master/examples", "title": "hubot/examples at master · github/hubot · GitHub", "count": 340, "uniques": 260 }, { "path": "/github/hubot/blob/master/docs/deploying/heroku.md", "title": "hubot/heroku.md at master · github/hubot · GitHub", "count": 324, "uniques": 217 }, { "path": "/github/hubot/blob/master/src/robot.coffee", "title": "hubot/robot.coffee at master · github/hubot · GitHub", "count": 293, "uniques": 191 }, { "path": "/github/hubot/blob/master/LICENSE.md", "title": "hubot/LICENSE.md at master · github/hubot · GitHub", "count": 281, "uniques": 222 } ], "schema": { "type": "array", "items": { "title": "Content Traffic", "description": "Content Traffic", "type": "object", "properties": { "path": { "type": "string", "examples": [ "/github/hubot" ] }, "title": { "type": "string", "examples": [ "github/hubot: A customizable life embetterment robot." ] }, "count": { "type": "integer", "examples": [ 3542 ] }, "uniques": { "type": "integer", "examples": [ 2225 ] } }, "required": [ "path", "title", "uniques", "count" ] } } } } ], "previews": [], "descriptionHTML": "Get the top 10 popular contents over the last 14 days.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/traffic/popular/referrers", "title": "Get top referral sources", "category": "metrics", "subcategory": "traffic", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "referrer": "Google", "count": 4, "uniques": 3 }, { "referrer": "stackoverflow.com", "count": 2, "uniques": 2 }, { "referrer": "eggsonbread.com", "count": 1, "uniques": 1 }, { "referrer": "yandex.ru", "count": 1, "uniques": 1 } ], "schema": { "type": "array", "items": { "title": "Referrer Traffic", "description": "Referrer Traffic", "type": "object", "properties": { "referrer": { "type": "string", "examples": [ "Google" ] }, "count": { "type": "integer", "examples": [ 4 ] }, "uniques": { "type": "integer", "examples": [ 3 ] } }, "required": [ "referrer", "uniques", "count" ] } } } } ], "previews": [], "descriptionHTML": "Get the top 10 referrers over the last 14 days.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/traffic/views", "title": "Get page views", "category": "metrics", "subcategory": "traffic", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per", "description": "The time frame to display results for.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "", "day", "week" ], "default": "day" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "count": 14850, "uniques": 3782, "views": [ { "timestamp": "2016-10-10T00:00:00Z", "count": 440, "uniques": 143 }, { "timestamp": "2016-10-11T00:00:00Z", "count": 1308, "uniques": 414 }, { "timestamp": "2016-10-12T00:00:00Z", "count": 1486, "uniques": 452 }, { "timestamp": "2016-10-13T00:00:00Z", "count": 1170, "uniques": 401 }, { "timestamp": "2016-10-14T00:00:00Z", "count": 868, "uniques": 266 }, { "timestamp": "2016-10-15T00:00:00Z", "count": 495, "uniques": 157 }, { "timestamp": "2016-10-16T00:00:00Z", "count": 524, "uniques": 175 }, { "timestamp": "2016-10-17T00:00:00Z", "count": 1263, "uniques": 412 }, { "timestamp": "2016-10-18T00:00:00Z", "count": 1402, "uniques": 417 }, { "timestamp": "2016-10-19T00:00:00Z", "count": 1394, "uniques": 424 }, { "timestamp": "2016-10-20T00:00:00Z", "count": 1492, "uniques": 448 }, { "timestamp": "2016-10-21T00:00:00Z", "count": 1153, "uniques": 332 }, { "timestamp": "2016-10-22T00:00:00Z", "count": 566, "uniques": 168 }, { "timestamp": "2016-10-23T00:00:00Z", "count": 675, "uniques": 184 }, { "timestamp": "2016-10-24T00:00:00Z", "count": 614, "uniques": 237 } ] }, "schema": { "title": "View Traffic", "description": "View Traffic", "type": "object", "properties": { "count": { "type": "integer", "examples": [ 14850 ] }, "uniques": { "type": "integer", "examples": [ 3782 ] }, "views": { "type": "array", "items": { "title": "Traffic", "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "uniques": { "type": "integer" }, "count": { "type": "integer" } }, "required": [ "timestamp", "uniques", "count" ] } } }, "required": [ "uniques", "count", "views" ] } } } ], "previews": [], "descriptionHTML": "Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] } ] }, "migrations": { "orgs": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/migrations", "title": "List organization migrations", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "exclude", "description": "Exclude attributes from the API response to improve performance
", "in": "query", "schema": { "type": "array", "items": { "description": "Allowed values that can be passed to the exclude param.", "enum": [ "repositories" ], "type": "string", "examples": [ "repositories" ] } } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 79, "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "state": "pending", "lock_repositories": true, "exclude_attachments": false, "exclude_releases": false, "exclude_owner_projects": false, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ], "url": "https://api.github.com/orgs/octo-org/migrations/79", "created_at": "2015-07-06T15:33:38-07:00", "updated_at": "2015-07-06T15:33:38-07:00", "node_id": "MDQ6VXNlcjE=" } ], "schema": { "type": "array", "items": { "title": "Migration", "description": "A migration.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 79 ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "guid": { "type": "string", "examples": [ "0b989ba4-242f-11e5-81e1-c7b6966d2516" ] }, "state": { "type": "string", "examples": [ "pending" ] }, "lock_repositories": { "type": "boolean", "examples": [ true ] }, "exclude_metadata": { "type": "boolean" }, "exclude_git_data": { "type": "boolean" }, "exclude_attachments": { "type": "boolean" }, "exclude_releases": { "type": "boolean" }, "exclude_owner_projects": { "type": "boolean" }, "org_metadata_only": { "type": "boolean" }, "repositories": { "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octo-org/migrations/79" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2015-07-06T15:33:38-07:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2015-07-06T15:33:38-07:00" ] }, "node_id": { "type": "string" }, "archive_url": { "type": "string", "format": "uri" }, "exclude": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "owner", "guid", "state", "lock_repositories", "exclude_metadata", "exclude_git_data", "exclude_attachments", "exclude_releases", "exclude_owner_projects", "org_metadata_only", "repositories", "url", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists the most recent migrations.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/migrations", "title": "Start an organization migration", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of strings", "name": "repositories", "in": "body", "description": "A list of arrays indicating which repositories should be migrated.
", "isRequired": true }, { "type": "boolean", "name": "lock_repositories", "in": "body", "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.
" }, { "type": "boolean", "name": "exclude_metadata", "in": "body", "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.
" }, { "type": "boolean", "name": "exclude_git_data", "in": "body", "description": "Indicates whether the repository git data should be excluded from the migration.
" }, { "type": "boolean", "name": "exclude_attachments", "in": "body", "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).
" }, { "type": "boolean", "name": "exclude_releases", "in": "body", "description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).
" }, { "type": "boolean", "name": "exclude_owner_projects", "in": "body", "description": "Indicates whether projects owned by the organization or users should be excluded. from the migration.
" }, { "type": "boolean", "name": "org_metadata_only", "in": "body", "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).
" }, { "type": "array of strings", "name": "exclude", "in": "body", "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".
Response
", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "state": "pending", "lock_repositories": true, "exclude_attachments": false, "exclude_releases": false, "exclude_owner_projects": false, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ], "url": "https://api.github.com/orgs/octo-org/migrations/79", "created_at": "2015-07-06T15:33:38-07:00", "updated_at": "2015-07-06T15:33:38-07:00" }, "schema": { "title": "Migration", "description": "A migration.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 79 ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "guid": { "type": "string", "examples": [ "0b989ba4-242f-11e5-81e1-c7b6966d2516" ] }, "state": { "type": "string", "examples": [ "pending" ] }, "lock_repositories": { "type": "boolean", "examples": [ true ] }, "exclude_metadata": { "type": "boolean" }, "exclude_git_data": { "type": "boolean" }, "exclude_attachments": { "type": "boolean" }, "exclude_releases": { "type": "boolean" }, "exclude_owner_projects": { "type": "boolean" }, "org_metadata_only": { "type": "boolean" }, "repositories": { "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octo-org/migrations/79" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2015-07-06T15:33:38-07:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2015-07-06T15:33:38-07:00" ] }, "node_id": { "type": "string" }, "archive_url": { "type": "string", "format": "uri" }, "exclude": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "owner", "guid", "state", "lock_repositories", "exclude_metadata", "exclude_git_data", "exclude_attachments", "exclude_releases", "exclude_owner_projects", "org_metadata_only", "repositories", "url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Initiates the generation of a migration archive.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/migrations/{migration_id}", "title": "Get an organization migration status", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "migration_id", "description": "The unique identifier of the migration.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "exclude", "description": "Exclude attributes from the API response to improve performance
", "in": "query", "schema": { "type": "array", "items": { "description": "Allowed values that can be passed to the exclude param.", "enum": [ "repositories" ], "type": "string", "examples": [ "repositories" ] } } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "- \n
pending, which means the migration hasn't started yet. \nexporting, which means the migration is in progress. \nexported, which means the migration finished successfully. \nfailed, which means the migration failed. \n
Fetches the status of a migration.
\nThe state of a migration can be one of the following values:
- \n
pending, which means the migration hasn't started yet. \nexporting, which means the migration is in progress. \nexported, which means the migration finished successfully. \nfailed, which means the migration failed. \n
- \n
pending, which means the migration hasn't started yet. \nexporting, which means the migration is in progress. \nexported, which means the migration finished successfully. \nfailed, which means the migration failed. \n
Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/migrations/{migration_id}/archive", "title": "Download an organization migration archive", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "migration_id", "description": "The unique identifier of the migration.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "302", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Fetches the URL to a migration archive.
", "statusCodes": [ { "httpStatusCode": "302", "description": "Found
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/migrations/{migration_id}/archive", "title": "Delete an organization migration archive", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "migration_id", "description": "The unique identifier of the migration.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", "title": "Unlock an organization repository", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "migration_id", "description": "The unique identifier of the migration.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "repo_name", "description": "repo_name parameter
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "migration_id": "MIGRATION_ID", "repo_name": "REPO_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/migrations/{migration_id}/repositories", "title": "List repositories in an organization migration", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "migration_id", "description": "The unique identifier of the migration.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": null } ], "schema": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } ], "previews": [], "descriptionHTML": "List all the repositories for this organization migration.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "source-imports": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/import", "title": "Get an import status", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "vcs": "subversion", "use_lfs": true, "vcs_url": "http://svn.mycompany.com/svn/myproject", "status": "complete", "status_text": "Done", "has_large_files": true, "large_files_size": 132331036, "large_files_count": 1, "authors_count": 4, "url": "https://api.github.com/repos/octocat/socm/import", "html_url": "https://import.github.com/octocat/socm/import", "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", "repository_url": "https://api.github.com/repos/octocat/socm" }, "schema": { "title": "Import", "description": "A repository import from an external source.", "type": "object", "properties": { "vcs": { "type": [ "string", "null" ] }, "use_lfs": { "type": "boolean" }, "vcs_url": { "description": "The URL of the originating repository.", "type": "string" }, "svc_root": { "type": "string" }, "tfvc_project": { "type": "string" }, "status": { "type": "string", "enum": [ "auth", "error", "none", "detecting", "choose", "auth_failed", "importing", "mapping", "waiting_to_push", "pushing", "complete", "setup", "unknown", "detection_found_multiple", "detection_found_nothing", "detection_needs_auth" ] }, "status_text": { "type": [ "string", "null" ] }, "failed_step": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "import_percent": { "type": [ "integer", "null" ] }, "commit_count": { "type": [ "integer", "null" ] }, "push_percent": { "type": [ "integer", "null" ] }, "has_large_files": { "type": "boolean" }, "large_files_size": { "type": "integer" }, "large_files_count": { "type": "integer" }, "project_choices": { "type": "array", "items": { "type": "object", "properties": { "vcs": { "type": "string" }, "tfvc_project": { "type": "string" }, "human_name": { "type": "string" } } } }, "message": { "type": "string" }, "authors_count": { "type": [ "integer", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "authors_url": { "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "svn_root": { "type": "string" } }, "required": [ "vcs", "vcs_url", "status", "url", "repository_url", "html_url", "authors_url" ] } } } ], "previews": [], "descriptionHTML": "View the progress of an import.
\nImport status
\nThis section includes details about the possible values of the status field of the Import Progress response.
An import that does not have errors will progress through these steps:
\n- \n
detecting- the \"detection\" step of the import is in progress because the request did not include avcsparameter. The import is identifying the type of source control present at the URL. \nimporting- the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will includecommit_count(the total number of raw commits that will be imported) andpercent(0 - 100, the current progress through the import). \nmapping- the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. \npushing- the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will includepush_percent, which is the percent value reported bygit pushwhen it is \"Writing objects\". \ncomplete- the import is complete, and the repository is ready on GitHub. \n
If there are problems, you will see one of these in the status field:
- \n
auth_failed- the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section. \nerror- the import encountered an error. The import progress response will include thefailed_stepand an error message. Contact GitHub Support for more information. \ndetection_needs_auth- the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section. \ndetection_found_nothing- the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL. \ndetection_found_multiple- the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include aproject_choicesfield with the possible project choices as values. To update project choice, please see the Update an import section. \n
The project_choices field
\nWhen multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
Git LFS related fields
\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.
\n- \n
use_lfs- describes whether the import has been opted in or out of using Git LFS. The value can beopt_in,opt_out, orundecidedif no action has been taken. \nhas_large_files- the boolean value describing whether files larger than 100MB were found during theimportingstep. \nlarge_files_size- the total size in gigabytes of files larger than 100MB found in the originating repository. \nlarge_files_count- the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request. \n
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/import", "title": "Start an import", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "vcs_url", "in": "body", "description": "The URL of the originating repository.
", "isRequired": true }, { "type": "string", "name": "vcs", "in": "body", "description": "The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.
", "enum": [ "subversion", "git", "mercurial", "tfvc" ] }, { "type": "string", "name": "vcs_username", "in": "body", "description": "If authentication is required, the username to provide to vcs_url.
If authentication is required, the password to provide to vcs_url.
For a tfvc import, the name of the project that is being imported.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "vcs": "subversion", "vcs_url": "http://svn.mycompany.com/svn/myproject", "vcs_username": "octocat", "vcs_password": "secret" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "vcs": "subversion", "use_lfs": true, "vcs_url": "http://svn.mycompany.com/svn/myproject", "status": "importing", "status_text": "Importing...", "has_large_files": false, "large_files_size": 0, "large_files_count": 0, "authors_count": 0, "commit_count": 1042, "url": "https://api.github.com/repos/octocat/socm/import", "html_url": "https://import.github.com/octocat/socm/import", "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", "repository_url": "https://api.github.com/repos/octocat/socm" }, "schema": { "title": "Import", "description": "A repository import from an external source.", "type": "object", "properties": { "vcs": { "type": [ "string", "null" ] }, "use_lfs": { "type": "boolean" }, "vcs_url": { "description": "The URL of the originating repository.", "type": "string" }, "svc_root": { "type": "string" }, "tfvc_project": { "type": "string" }, "status": { "type": "string", "enum": [ "auth", "error", "none", "detecting", "choose", "auth_failed", "importing", "mapping", "waiting_to_push", "pushing", "complete", "setup", "unknown", "detection_found_multiple", "detection_found_nothing", "detection_needs_auth" ] }, "status_text": { "type": [ "string", "null" ] }, "failed_step": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "import_percent": { "type": [ "integer", "null" ] }, "commit_count": { "type": [ "integer", "null" ] }, "push_percent": { "type": [ "integer", "null" ] }, "has_large_files": { "type": "boolean" }, "large_files_size": { "type": "integer" }, "large_files_count": { "type": "integer" }, "project_choices": { "type": "array", "items": { "type": "object", "properties": { "vcs": { "type": "string" }, "tfvc_project": { "type": "string" }, "human_name": { "type": "string" } } } }, "message": { "type": "string" }, "authors_count": { "type": [ "integer", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "authors_url": { "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "svn_root": { "type": "string" } }, "required": [ "vcs", "vcs_url", "status", "url", "repository_url", "html_url", "authors_url" ] } } } ], "previews": [], "descriptionHTML": "Start a source import to a GitHub repository using GitHub Importer.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/import", "title": "Update an import", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "vcs_username", "in": "body", "description": "The username to provide to the originating repository.
" }, { "type": "string", "name": "vcs_password", "in": "body", "description": "The password to provide to the originating repository.
" }, { "type": "string", "name": "vcs", "in": "body", "description": "The type of version control system you are migrating from.
", "enum": [ "subversion", "tfvc", "git", "mercurial" ] }, { "type": "string", "name": "tfvc_project", "in": "body", "description": "For a tfvc import, the name of the project that is being imported.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "example-1", "request": { "contentType": "application/json", "description": "Update authentication for an import", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "vcs_username": "octocat", "vcs_password": "secret" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Example 1
", "example": { "vcs": "subversion", "use_lfs": true, "vcs_url": "http://svn.mycompany.com/svn/myproject", "status": "detecting", "url": "https://api.github.com/repos/octocat/socm/import", "html_url": "https://import.github.com/octocat/socm/import", "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", "repository_url": "https://api.github.com/repos/octocat/socm" }, "schema": { "title": "Import", "description": "A repository import from an external source.", "type": "object", "properties": { "vcs": { "type": [ "string", "null" ] }, "use_lfs": { "type": "boolean" }, "vcs_url": { "description": "The URL of the originating repository.", "type": "string" }, "svc_root": { "type": "string" }, "tfvc_project": { "type": "string" }, "status": { "type": "string", "enum": [ "auth", "error", "none", "detecting", "choose", "auth_failed", "importing", "mapping", "waiting_to_push", "pushing", "complete", "setup", "unknown", "detection_found_multiple", "detection_found_nothing", "detection_needs_auth" ] }, "status_text": { "type": [ "string", "null" ] }, "failed_step": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "import_percent": { "type": [ "integer", "null" ] }, "commit_count": { "type": [ "integer", "null" ] }, "push_percent": { "type": [ "integer", "null" ] }, "has_large_files": { "type": "boolean" }, "large_files_size": { "type": "integer" }, "large_files_count": { "type": "integer" }, "project_choices": { "type": "array", "items": { "type": "object", "properties": { "vcs": { "type": "string" }, "tfvc_project": { "type": "string" }, "human_name": { "type": "string" } } } }, "message": { "type": "string" }, "authors_count": { "type": [ "integer", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "authors_url": { "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "svn_root": { "type": "string" } }, "required": [ "vcs", "vcs_url", "status", "url", "repository_url", "html_url", "authors_url" ] } } }, { "key": "example-2", "request": { "contentType": "application/json", "description": "Updating the project choice", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "vcs": "tfvc", "tfvc_project": "project1", "human_name": "project1 (tfs)" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Example 2
", "example": { "vcs": "tfvc", "use_lfs": true, "vcs_url": "http://tfs.mycompany.com/tfs/myproject", "tfvc_project": "project1", "status": "importing", "status_text": "Importing...", "has_large_files": false, "large_files_size": 0, "large_files_count": 0, "authors_count": 0, "commit_count": 1042, "url": "https://api.github.com/repos/octocat/socm/import", "html_url": "https://import.github.com/octocat/socm/import", "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", "repository_url": "https://api.github.com/repos/octocat/socm" }, "schema": { "title": "Import", "description": "A repository import from an external source.", "type": "object", "properties": { "vcs": { "type": [ "string", "null" ] }, "use_lfs": { "type": "boolean" }, "vcs_url": { "description": "The URL of the originating repository.", "type": "string" }, "svc_root": { "type": "string" }, "tfvc_project": { "type": "string" }, "status": { "type": "string", "enum": [ "auth", "error", "none", "detecting", "choose", "auth_failed", "importing", "mapping", "waiting_to_push", "pushing", "complete", "setup", "unknown", "detection_found_multiple", "detection_found_nothing", "detection_needs_auth" ] }, "status_text": { "type": [ "string", "null" ] }, "failed_step": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "import_percent": { "type": [ "integer", "null" ] }, "commit_count": { "type": [ "integer", "null" ] }, "push_percent": { "type": [ "integer", "null" ] }, "has_large_files": { "type": "boolean" }, "large_files_size": { "type": "integer" }, "large_files_count": { "type": "integer" }, "project_choices": { "type": "array", "items": { "type": "object", "properties": { "vcs": { "type": "string" }, "tfvc_project": { "type": "string" }, "human_name": { "type": "string" } } } }, "message": { "type": "string" }, "authors_count": { "type": [ "integer", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "authors_url": { "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "svn_root": { "type": "string" } }, "required": [ "vcs", "vcs_url", "status", "url", "repository_url", "html_url", "authors_url" ] } } }, { "key": "example-3", "request": { "contentType": "application/json", "description": "Restarting an import", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "vcs": "subversion", "use_lfs": true, "vcs_url": "http://svn.mycompany.com/svn/myproject", "status": "importing", "status_text": "Importing...", "has_large_files": false, "large_files_size": 0, "large_files_count": 0, "authors_count": 0, "commit_count": 1042, "url": "https://api.github.com/repos/octocat/socm/import", "html_url": "https://import.github.com/octocat/socm/import", "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", "repository_url": "https://api.github.com/repos/octocat/socm" }, "schema": { "title": "Import", "description": "A repository import from an external source.", "type": "object", "properties": { "vcs": { "type": [ "string", "null" ] }, "use_lfs": { "type": "boolean" }, "vcs_url": { "description": "The URL of the originating repository.", "type": "string" }, "svc_root": { "type": "string" }, "tfvc_project": { "type": "string" }, "status": { "type": "string", "enum": [ "auth", "error", "none", "detecting", "choose", "auth_failed", "importing", "mapping", "waiting_to_push", "pushing", "complete", "setup", "unknown", "detection_found_multiple", "detection_found_nothing", "detection_needs_auth" ] }, "status_text": { "type": [ "string", "null" ] }, "failed_step": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "import_percent": { "type": [ "integer", "null" ] }, "commit_count": { "type": [ "integer", "null" ] }, "push_percent": { "type": [ "integer", "null" ] }, "has_large_files": { "type": "boolean" }, "large_files_size": { "type": "integer" }, "large_files_count": { "type": "integer" }, "project_choices": { "type": "array", "items": { "type": "object", "properties": { "vcs": { "type": "string" }, "tfvc_project": { "type": "string" }, "human_name": { "type": "string" } } } }, "message": { "type": "string" }, "authors_count": { "type": [ "integer", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "authors_url": { "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "svn_root": { "type": "string" } }, "required": [ "vcs", "vcs_url", "status", "url", "repository_url", "html_url", "authors_url" ] } } } ], "previews": [], "descriptionHTML": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.
\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/import", "title": "Cancel an import", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Stop an import for a repository.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/import/authors", "title": "Get commit authors", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "since", "description": "A user ID. Only return users with an ID greater than this ID.
", "in": "query", "required": false, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 2268557, "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", "remote_name": "nobody", "email": "hubot@github.com", "name": "Hubot", "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", "import_url": "https://api.github.com/repos/octocat/socm/import" }, { "id": 2268558, "remote_id": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", "remote_name": "svner", "email": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", "name": "svner", "url": "https://api.github.com/repos/octocat/socm/import/authors/2268558", "import_url": "https://api.github.com/repos/octocat/socm/import" }, { "id": 2268559, "remote_id": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", "remote_name": "svner@example.com", "email": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", "name": "svner@example.com", "url": "https://api.github.com/repos/octocat/socm/import/authors/2268559", "import_url": "https://api.github.com/repos/octocat/socm/import" } ], "schema": { "type": "array", "items": { "title": "Porter Author", "description": "Porter Author", "type": "object", "properties": { "id": { "type": "integer" }, "remote_id": { "type": "string" }, "remote_name": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "import_url": { "type": "string", "format": "uri" } }, "required": [ "id", "remote_id", "remote_name", "email", "name", "url", "import_url" ] } } } } ], "previews": [], "descriptionHTML": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.
This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/import/authors/{author_id}", "title": "Map a commit author", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "author_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [ { "type": "string", "name": "email", "in": "body", "description": "The new Git author email.
" }, { "type": "string", "name": "name", "in": "body", "description": "The new Git author name.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "email": "hubot@github.com", "name": "Hubot the Robot" }, "parameters": { "owner": "OWNER", "repo": "REPO", "author_id": "AUTHOR_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 2268557, "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", "remote_name": "nobody", "email": "hubot@github.com", "name": "Hubot", "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", "import_url": "https://api.github.com/repos/octocat/socm/import" }, "schema": { "title": "Porter Author", "description": "Porter Author", "type": "object", "properties": { "id": { "type": "integer" }, "remote_id": { "type": "string" }, "remote_name": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "import_url": { "type": "string", "format": "uri" } }, "required": [ "id", "remote_id", "remote_name", "email", "name", "url", "import_url" ] } } } ], "previews": [], "descriptionHTML": "Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/import/large_files", "title": "Get large files", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "ref_name": "refs/heads/master", "path": "foo/bar/1", "oid": "d3d9446802a44259755d38e6d163e820", "size": 10485760 }, { "ref_name": "refs/heads/master", "path": "foo/bar/2", "oid": "6512bd43d9caa6e02c990b0a82652dca", "size": 11534336 }, { "ref_name": "refs/heads/master", "path": "foo/bar/3", "oid": "c20ad4d76fe97759aa27a0c99bff6710", "size": 12582912 } ], "schema": { "type": "array", "items": { "title": "Porter Large File", "description": "Porter Large File", "type": "object", "properties": { "ref_name": { "type": "string" }, "path": { "type": "string" }, "oid": { "type": "string" }, "size": { "type": "integer" } }, "required": [ "oid", "path", "ref_name", "size" ] } } } } ], "previews": [], "descriptionHTML": "List files larger than 100MB found during the import
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/import/lfs", "title": "Update Git LFS preference", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "use_lfs", "in": "body", "description": "Whether to store large files during the import. opt_in means large files will be stored using Git LFS. opt_out means large files will be removed during the import.
Response
", "example": { "vcs": "subversion", "use_lfs": true, "vcs_url": "http://svn.mycompany.com/svn/myproject", "status": "complete", "status_text": "Done", "has_large_files": true, "large_files_size": 132331036, "large_files_count": 1, "authors_count": 4, "url": "https://api.github.com/repos/octocat/socm/import", "html_url": "https://import.github.com/octocat/socm/import", "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", "repository_url": "https://api.github.com/repos/octocat/socm" }, "schema": { "title": "Import", "description": "A repository import from an external source.", "type": "object", "properties": { "vcs": { "type": [ "string", "null" ] }, "use_lfs": { "type": "boolean" }, "vcs_url": { "description": "The URL of the originating repository.", "type": "string" }, "svc_root": { "type": "string" }, "tfvc_project": { "type": "string" }, "status": { "type": "string", "enum": [ "auth", "error", "none", "detecting", "choose", "auth_failed", "importing", "mapping", "waiting_to_push", "pushing", "complete", "setup", "unknown", "detection_found_multiple", "detection_found_nothing", "detection_needs_auth" ] }, "status_text": { "type": [ "string", "null" ] }, "failed_step": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "import_percent": { "type": [ "integer", "null" ] }, "commit_count": { "type": [ "integer", "null" ] }, "push_percent": { "type": [ "integer", "null" ] }, "has_large_files": { "type": "boolean" }, "large_files_size": { "type": "integer" }, "large_files_count": { "type": "integer" }, "project_choices": { "type": "array", "items": { "type": "object", "properties": { "vcs": { "type": "string" }, "tfvc_project": { "type": "string" }, "human_name": { "type": "string" } } } }, "message": { "type": "string" }, "authors_count": { "type": [ "integer", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "authors_url": { "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "svn_root": { "type": "string" } }, "required": [ "vcs", "vcs_url", "status", "url", "repository_url", "html_url", "authors_url" ] } } } ], "previews": [], "descriptionHTML": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by Git LFS. You can learn more about our LFS feature and working with large files on our help site.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "users": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/migrations", "title": "List user migrations", "category": "migrations", "subcategory": "users", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 79, "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "state": "pending", "lock_repositories": true, "exclude_attachments": false, "exclude_releases": false, "exclude_owner_projects": false, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ], "url": "https://api.github.com/orgs/octo-org/migrations/79", "created_at": "2015-07-06T15:33:38-07:00", "updated_at": "2015-07-06T15:33:38-07:00", "node_id": "MDQ6VXNlcjE=" } ], "schema": { "type": "array", "items": { "title": "Migration", "description": "A migration.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 79 ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "guid": { "type": "string", "examples": [ "0b989ba4-242f-11e5-81e1-c7b6966d2516" ] }, "state": { "type": "string", "examples": [ "pending" ] }, "lock_repositories": { "type": "boolean", "examples": [ true ] }, "exclude_metadata": { "type": "boolean" }, "exclude_git_data": { "type": "boolean" }, "exclude_attachments": { "type": "boolean" }, "exclude_releases": { "type": "boolean" }, "exclude_owner_projects": { "type": "boolean" }, "org_metadata_only": { "type": "boolean" }, "repositories": { "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octo-org/migrations/79" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2015-07-06T15:33:38-07:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2015-07-06T15:33:38-07:00" ] }, "node_id": { "type": "string" }, "archive_url": { "type": "string", "format": "uri" }, "exclude": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "owner", "guid", "state", "lock_repositories", "exclude_metadata", "exclude_git_data", "exclude_attachments", "exclude_releases", "exclude_owner_projects", "org_metadata_only", "repositories", "url", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists all migrations a user has started.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/migrations", "title": "Start a user migration", "category": "migrations", "subcategory": "users", "parameters": [], "bodyParameters": [ { "type": "boolean", "name": "lock_repositories", "in": "body", "description": "Lock the repositories being migrated at the start of the migration
" }, { "type": "boolean", "name": "exclude_metadata", "in": "body", "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.
" }, { "type": "boolean", "name": "exclude_git_data", "in": "body", "description": "Indicates whether the repository git data should be excluded from the migration.
" }, { "type": "boolean", "name": "exclude_attachments", "in": "body", "description": "Do not include attachments in the migration
" }, { "type": "boolean", "name": "exclude_releases", "in": "body", "description": "Do not include releases in the migration
" }, { "type": "boolean", "name": "exclude_owner_projects", "in": "body", "description": "Indicates whether projects owned by the organization or users should be excluded.
" }, { "type": "boolean", "name": "org_metadata_only", "in": "body", "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).
" }, { "type": "array of strings", "name": "exclude", "in": "body", "description": "Exclude attributes from the API response to improve performance
" }, { "type": "array of strings", "name": "repositories", "in": "body", "description": "", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repositories": [ "octocat/Hello-World" ], "lock_repositories": true } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "state": "pending", "lock_repositories": true, "exclude_attachments": false, "exclude_releases": false, "exclude_owner_projects": false, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ], "url": "https://api.github.com/orgs/octo-org/migrations/79", "created_at": "2015-07-06T15:33:38-07:00", "updated_at": "2015-07-06T15:33:38-07:00" }, "schema": { "title": "Migration", "description": "A migration.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 79 ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "guid": { "type": "string", "examples": [ "0b989ba4-242f-11e5-81e1-c7b6966d2516" ] }, "state": { "type": "string", "examples": [ "pending" ] }, "lock_repositories": { "type": "boolean", "examples": [ true ] }, "exclude_metadata": { "type": "boolean" }, "exclude_git_data": { "type": "boolean" }, "exclude_attachments": { "type": "boolean" }, "exclude_releases": { "type": "boolean" }, "exclude_owner_projects": { "type": "boolean" }, "org_metadata_only": { "type": "boolean" }, "repositories": { "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octo-org/migrations/79" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2015-07-06T15:33:38-07:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2015-07-06T15:33:38-07:00" ] }, "node_id": { "type": "string" }, "archive_url": { "type": "string", "format": "uri" }, "exclude": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "owner", "guid", "state", "lock_repositories", "exclude_metadata", "exclude_git_data", "exclude_attachments", "exclude_releases", "exclude_owner_projects", "org_metadata_only", "repositories", "url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Initiates the generation of a user migration archive.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/migrations/{migration_id}", "title": "Get a user migration status", "category": "migrations", "subcategory": "users", "parameters": [ { "name": "migration_id", "description": "The unique identifier of the migration.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "state": "exported", "lock_repositories": true, "exclude_attachments": false, "exclude_releases": false, "exclude_owner_projects": false, "org_metadata_only": false, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ], "url": "https://api.github.com/orgs/octo-org/migrations/79", "created_at": "2015-07-06T15:33:38-07:00", "updated_at": "2015-07-06T15:33:38-07:00" }, "schema": { "title": "Migration", "description": "A migration.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 79 ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "guid": { "type": "string", "examples": [ "0b989ba4-242f-11e5-81e1-c7b6966d2516" ] }, "state": { "type": "string", "examples": [ "pending" ] }, "lock_repositories": { "type": "boolean", "examples": [ true ] }, "exclude_metadata": { "type": "boolean" }, "exclude_git_data": { "type": "boolean" }, "exclude_attachments": { "type": "boolean" }, "exclude_releases": { "type": "boolean" }, "exclude_owner_projects": { "type": "boolean" }, "org_metadata_only": { "type": "boolean" }, "repositories": { "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octo-org/migrations/79" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2015-07-06T15:33:38-07:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2015-07-06T15:33:38-07:00" ] }, "node_id": { "type": "string" }, "archive_url": { "type": "string", "format": "uri" }, "exclude": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "owner", "guid", "state", "lock_repositories", "exclude_metadata", "exclude_git_data", "exclude_attachments", "exclude_releases", "exclude_owner_projects", "org_metadata_only", "repositories", "url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Fetches a single user migration. The response includes the state of the migration, which can be one of the following values:
- \n
pending- the migration hasn't started yet. \nexporting- the migration is in progress. \nexported- the migration finished successfully. \nfailed- the migration failed. \n
Once the migration has been exported you can download the migration archive.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/migrations/{migration_id}/archive", "title": "Download a user migration archive", "category": "migrations", "subcategory": "users", "parameters": [ { "name": "migration_id", "description": "The unique identifier of the migration.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [], "previews": [], "descriptionHTML": "Fetches the URL to download the migration archive as a tar.gz file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:
- \n
- attachments \n
- bases \n
- commit_comments \n
- issue_comments \n
- issue_events \n
- issues \n
- milestones \n
- organizations \n
- projects \n
- protected_branches \n
- pull_request_reviews \n
- pull_requests \n
- releases \n
- repositories \n
- review_comments \n
- schema \n
- users \n
The archive will also contain an attachments directory that includes all attachment files uploaded to GitHub.com and a repositories directory that contains the repository's Git data.
Found
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/migrations/{migration_id}/archive", "title": "Delete a user migration archive", "category": "migrations", "subcategory": "users", "parameters": [ { "name": "migration_id", "description": "The unique identifier of the migration.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the List user migrations and Get a user migration status endpoints, will continue to be available even after an archive is deleted.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/migrations/{migration_id}/repos/{repo_name}/lock", "title": "Unlock a user repository", "category": "migrations", "subcategory": "users", "parameters": [ { "name": "migration_id", "description": "The unique identifier of the migration.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "repo_name", "description": "repo_name parameter
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID", "repo_name": "REPO_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Unlocks a repository. You can lock repositories when you start a user migration. Once the migration is complete you can unlock each repository to begin using it again or delete the repository if you no longer need the source data. Returns a status of 404 Not Found if the repository is not locked.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/migrations/{migration_id}/repositories", "title": "List repositories for a user migration", "category": "migrations", "subcategory": "users", "parameters": [ { "name": "migration_id", "description": "The unique identifier of the migration.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": null } ], "schema": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists all the repositories for this user migration.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ] }, "orgs": { "orgs": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/organizations", "title": "List organizations", "category": "orgs", "parameters": [ { "name": "since", "description": "An organization ID. Only return organizations with an ID greater than this ID.
", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" } ], "schema": { "type": "array", "items": { "title": "Organization Simple", "description": "Organization Simple", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] } } } } ], "previews": [], "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}", "title": "Get an organization", "category": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Default response
", "example": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "twitter_username": "github", "is_verified": true, "has_organization_projects": true, "has_repository_projects": true, "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "html_url": "https://github.com/octocat", "created_at": "2008-01-14T04:33:35Z", "updated_at": "2014-03-03T18:58:10Z", "type": "Organization", "total_private_repos": 100, "owned_private_repos": 100, "private_gists": 81, "disk_usage": 10000, "collaborators": 8, "billing_email": "mona@github.com", "plan": { "name": "Medium", "space": 400, "private_repos": 20, "filled_seats": 4, "seats": 5 }, "default_repository_permission": "read", "members_can_create_repositories": true, "two_factor_requirement_enabled": true, "members_allowed_repository_creation_type": "all", "members_can_create_public_repositories": false, "members_can_create_private_repositories": false, "members_can_create_internal_repositories": false, "members_can_create_pages": true, "members_can_fork_private_repositories": false }, "schema": { "title": "Organization Full", "description": "Organization Full", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] }, "name": { "type": "string", "examples": [ "github" ] }, "company": { "type": "string", "examples": [ "GitHub" ] }, "blog": { "type": "string", "format": "uri", "examples": [ "https://github.com/blog" ] }, "location": { "type": "string", "examples": [ "San Francisco" ] }, "email": { "type": "string", "format": "email", "examples": [ "octocat@github.com" ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "github" ] }, "is_verified": { "type": "boolean", "examples": [ true ] }, "has_organization_projects": { "type": "boolean", "examples": [ true ] }, "has_repository_projects": { "type": "boolean", "examples": [ true ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "type": { "type": "string", "examples": [ "Organization" ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "private_gists": { "type": [ "integer", "null" ], "examples": [ 81 ] }, "disk_usage": { "type": [ "integer", "null" ], "examples": [ 10000 ] }, "collaborators": { "type": [ "integer", "null" ], "examples": [ 8 ] }, "billing_email": { "type": [ "string", "null" ], "format": "email", "examples": [ "org@example.com" ] }, "plan": { "type": "object", "properties": { "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" }, "filled_seats": { "type": "integer" }, "seats": { "type": "integer" } }, "required": [ "name", "space", "private_repos" ] }, "default_repository_permission": { "type": [ "string", "null" ] }, "members_can_create_repositories": { "type": [ "boolean", "null" ], "examples": [ true ] }, "two_factor_requirement_enabled": { "type": [ "boolean", "null" ], "examples": [ true ] }, "members_allowed_repository_creation_type": { "type": "string", "examples": [ "all" ] }, "members_can_create_public_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_internal_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_public_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_pages": { "type": "boolean", "examples": [ true ] }, "members_can_fork_private_repositories": { "type": [ "boolean", "null" ], "examples": [ false ] }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] }, "updated_at": { "type": "string", "format": "date-time" }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description", "html_url", "has_organization_projects", "has_repository_projects", "public_repos", "public_gists", "followers", "following", "type", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub plan information' below.\"
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}", "title": "Update an organization", "category": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "billing_email", "in": "body", "description": "Billing email address. This address is not publicized.
" }, { "type": "string", "name": "company", "in": "body", "description": "The company name.
" }, { "type": "string", "name": "email", "in": "body", "description": "The publicly visible email address.
" }, { "type": "string", "name": "twitter_username", "in": "body", "description": "The Twitter username of the company.
" }, { "type": "string", "name": "location", "in": "body", "description": "The location.
" }, { "type": "string", "name": "name", "in": "body", "description": "The shorthand name of the company.
" }, { "type": "string", "name": "description", "in": "body", "description": "The description of the company.
" }, { "type": "boolean", "name": "has_organization_projects", "in": "body", "description": "Whether an organization can use organization projects.
" }, { "type": "boolean", "name": "has_repository_projects", "in": "body", "description": "Whether repositories that belong to the organization can use repository projects.
" }, { "type": "string", "name": "default_repository_permission", "in": "body", "description": "Default permission level members have for organization repositories.
", "enum": [ "read", "write", "admin", "none" ], "default": "read" }, { "type": "boolean", "name": "members_can_create_repositories", "in": "body", "description": "Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.
Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" }, { "type": "boolean", "name": "members_can_create_private_repositories", "in": "body", "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" }, { "type": "boolean", "name": "members_can_create_public_repositories", "in": "body", "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" }, { "type": "string", "name": "members_allowed_repository_creation_type", "in": "body", "description": "Specifies which types of repositories non-admin organization members can create. private is only available to repositories that are part of an organization on GitHub Enterprise Cloud.\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.
Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.
", "default": true }, { "type": "boolean", "name": "members_can_create_public_pages", "in": "body", "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.
", "default": true }, { "type": "boolean", "name": "members_can_create_private_pages", "in": "body", "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.
", "default": true }, { "type": "boolean", "name": "members_can_fork_private_repositories", "in": "body", "description": "Whether organization members can fork private organization repositories.
" }, { "type": "boolean", "name": "web_commit_signoff_required", "in": "body", "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.
" }, { "type": "string", "name": "blog", "in": "body", "description": "" }, { "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", "in": "body", "description": "Whether GitHub Advanced Security is automatically enabled for new repositories.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether Dependabot alerts is automatically enabled for new repositories.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether Dependabot security updates is automatically enabled for new repositories.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether dependency graph is automatically enabled for new repositories.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether secret scanning is automatically enabled for new repositories.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether secret scanning push protection is automatically enabled for new repositories.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Response
", "example": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "twitter_username": "github", "is_verified": true, "has_organization_projects": true, "has_repository_projects": true, "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "html_url": "https://github.com/octocat", "created_at": "2008-01-14T04:33:35Z", "type": "Organization", "total_private_repos": 100, "owned_private_repos": 100, "private_gists": 81, "disk_usage": 10000, "collaborators": 8, "billing_email": "mona@github.com", "plan": { "name": "Medium", "space": 400, "private_repos": 20 }, "default_repository_permission": "read", "members_can_create_repositories": true, "two_factor_requirement_enabled": true, "members_allowed_repository_creation_type": "all", "members_can_create_public_repositories": false, "members_can_create_private_repositories": false, "members_can_create_internal_repositories": false, "members_can_create_pages": true, "members_can_create_public_pages": true, "members_can_create_private_pages": true, "members_can_fork_private_repositories": false, "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z" }, "schema": { "title": "Organization Full", "description": "Organization Full", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] }, "name": { "type": "string", "examples": [ "github" ] }, "company": { "type": "string", "examples": [ "GitHub" ] }, "blog": { "type": "string", "format": "uri", "examples": [ "https://github.com/blog" ] }, "location": { "type": "string", "examples": [ "San Francisco" ] }, "email": { "type": "string", "format": "email", "examples": [ "octocat@github.com" ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "github" ] }, "is_verified": { "type": "boolean", "examples": [ true ] }, "has_organization_projects": { "type": "boolean", "examples": [ true ] }, "has_repository_projects": { "type": "boolean", "examples": [ true ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "type": { "type": "string", "examples": [ "Organization" ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "private_gists": { "type": [ "integer", "null" ], "examples": [ 81 ] }, "disk_usage": { "type": [ "integer", "null" ], "examples": [ 10000 ] }, "collaborators": { "type": [ "integer", "null" ], "examples": [ 8 ] }, "billing_email": { "type": [ "string", "null" ], "format": "email", "examples": [ "org@example.com" ] }, "plan": { "type": "object", "properties": { "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" }, "filled_seats": { "type": "integer" }, "seats": { "type": "integer" } }, "required": [ "name", "space", "private_repos" ] }, "default_repository_permission": { "type": [ "string", "null" ] }, "members_can_create_repositories": { "type": [ "boolean", "null" ], "examples": [ true ] }, "two_factor_requirement_enabled": { "type": [ "boolean", "null" ], "examples": [ true ] }, "members_allowed_repository_creation_type": { "type": "string", "examples": [ "all" ] }, "members_can_create_public_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_internal_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_public_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_pages": { "type": "boolean", "examples": [ true ] }, "members_can_fork_private_repositories": { "type": [ "boolean", "null" ], "examples": [ false ] }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] }, "updated_at": { "type": "string", "format": "date-time" }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false ] } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description", "html_url", "has_organization_projects", "has_repository_projects", "public_repos", "public_gists", "followers", "following", "type", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Parameter Deprecation Notice: GitHub will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.
OK
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/audit-log", "title": "Get the audit log for an organization", "category": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "phrase", "description": "A search phrase. For more information, see Searching the audit log.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "description": "The event types to include:
\n- \n
web- returns web (non-Git) events. \ngit- returns Git events. \nall- returns both web and Git events. \n
The default is web.
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "before", "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "description": "The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.
The default is desc.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "@timestamp": 1606929874512, "action": "team.add_member", "actor": "octocat", "created_at": 1606929874512, "_document_id": "xJJFlFOhQ6b-5vaAFy9Rjw", "org": "octo-corp", "team": "octo-corp/example-team", "user": "monalisa" }, { "@timestamp": 1606507117008, "action": "org.create", "actor": "octocat", "created_at": 1606507117008, "_document_id": "Vqvg6kZ4MYqwWRKFDzlMoQ", "org": "octocat-test-org" }, { "@timestamp": 1605719148837, "action": "repo.destroy", "actor": "monalisa", "created_at": 1605719148837, "_document_id": "LwW2vpJZCDS-WUmo9Z-ifw", "org": "mona-org", "repo": "mona-org/mona-test-repo", "visibility": "private" } ], "schema": { "type": "array", "items": { "type": "object", "properties": { "@timestamp": { "type": "integer", "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." }, "action": { "type": "string", "description": "The name of the action that was performed, for example `user.login` or `repo.create`." }, "active": { "type": "boolean" }, "active_was": { "type": "boolean" }, "actor": { "type": "string", "description": "The actor who performed the action." }, "actor_id": { "type": "integer", "description": "The id of the actor who performed the action." }, "actor_location": { "type": "object", "properties": { "country_name": { "type": "string" } } }, "data": { "type": "object", "additionalProperties": true }, "org_id": { "type": "integer" }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." }, "business": { "type": "string" }, "config": { "type": "array", "items": { "type": "object" } }, "config_was": { "type": "array", "items": { "type": "object" } }, "content_type": { "type": "string" }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." }, "deploy_key_fingerprint": { "type": "string" }, "_document_id": { "type": "string", "description": "A unique identifier for an audit event." }, "emoji": { "type": "string" }, "events": { "type": "array", "items": { "type": "object" } }, "events_were": { "type": "array", "items": { "type": "object" } }, "explanation": { "type": "string" }, "fingerprint": { "type": "string" }, "hook_id": { "type": "integer" }, "limited_availability": { "type": "boolean" }, "message": { "type": "string" }, "name": { "type": "string" }, "old_user": { "type": "string" }, "openssh_public_key": { "type": "string" }, "org": { "type": "string" }, "previous_visibility": { "type": "string" }, "read_only": { "type": "boolean" }, "repo": { "type": "string", "description": "The name of the repository." }, "repository": { "type": "string", "description": "The name of the repository." }, "repository_public": { "type": "boolean" }, "target_login": { "type": "string" }, "team": { "type": "string" }, "transport_protocol": { "type": "integer", "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." }, "transport_protocol_name": { "type": "string", "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." }, "user": { "type": "string", "description": "The user that was affected by the action performed (if available)." }, "visibility": { "type": "string", "description": "The repository visibility, for example `public` or `private`." } } } } } } ], "previews": [], "descriptionHTML": "Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"
\nThis endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the admin:org scope. GitHub Apps must have the organization_administration read permission to use this endpoint.
By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"
Use pagination to retrieve fewer or more than 30 events. For more information, see \"Resources in the REST API.\"
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/credential-authorizations", "title": "List SAML SSO authorizations for an organization", "category": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page token
", "in": "query", "schema": { "type": "integer" } }, { "name": "login", "description": "Limits the list of credentials authorizations for an organization to a specific login
", "in": "query", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "credential_id": 161195, "credential_type": "personal access token", "token_last_eight": "71c3fc11", "credential_authorized_at": "2011-01-26T19:06:43Z", "authorized_credential_expires_at": "2011-02-25T19:06:43Z", "scopes": [ "user", "repo" ] }, { "login": "hubot", "credential_id": 161196, "credential_type": "personal access token", "token_last_eight": "Ae178B4a", "credential_authorized_at": "2019-03-29T19:06:43Z", "authorized_credential_expires_at": "2019-04-28T19:06:43Z", "scopes": [ "repo" ] } ], "schema": { "type": "array", "items": { "title": "Credential Authorization", "description": "Credential Authorization", "type": "object", "properties": { "login": { "type": "string", "description": "User login that owns the underlying credential.", "examples": [ "monalisa" ] }, "credential_id": { "type": "integer", "description": "Unique identifier for the credential.", "examples": [ 1 ] }, "credential_type": { "type": "string", "description": "Human-readable description of the credential type.", "examples": [ "SSH Key" ] }, "token_last_eight": { "type": "string", "description": "Last eight characters of the credential. Only included in responses with credential_type of personal access token.", "examples": [ "12345678" ] }, "credential_authorized_at": { "type": "string", "format": "date-time", "description": "Date when the credential was authorized for use.", "examples": [ "2011-01-26T19:06:43Z" ] }, "scopes": { "type": "array", "description": "List of oauth scopes the token has been granted.", "items": { "type": "string" }, "examples": [ "user", "repo" ] }, "fingerprint": { "type": "string", "description": "Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key.", "examples": [ "jklmnop12345678" ] }, "credential_accessed_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Date when the credential was last accessed. May be null if it was never accessed", "examples": [ "2011-01-26T19:06:43Z" ] }, "authorized_credential_id": { "type": [ "integer", "null" ], "examples": [ 12345678 ] }, "authorized_credential_title": { "type": [ "string", "null" ], "description": "The title given to the ssh key. This will only be present when the credential is an ssh key.", "examples": [ "my ssh key" ] }, "authorized_credential_note": { "type": [ "string", "null" ], "description": "The note given to the token. This will only be present when the credential is a token.", "examples": [ "my token" ] }, "authorized_credential_expires_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The expiry for the token. This will only be present when the credential is a token." } }, "required": [ "login", "credential_id", "credential_type", "credential_authorized_at", "credential_accessed_at", "authorized_credential_id" ] } } } } ], "previews": [], "descriptionHTML": "Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see GitHub's products.
\nAn authenticated organization owner with the read:org scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see About authentication with SAML single sign-on.
OK
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/credential-authorizations/{credential_id}", "title": "Remove a SAML SSO authorization for an organization", "category": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "credential_id": "CREDENTIAL_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see GitHub's products.
\nAn authenticated organization owner with the admin:org scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access.
No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/installations", "title": "List app installations for an organization", "category": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "installations": [ { "id": 25381, "account": { "login": "octo-org", "id": 6811672, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octo-org", "html_url": "https://github.com/octo-org", "followers_url": "https://api.github.com/users/octo-org/followers", "following_url": "https://api.github.com/users/octo-org/following{/other_user}", "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", "organizations_url": "https://api.github.com/users/octo-org/orgs", "repos_url": "https://api.github.com/users/octo-org/repos", "events_url": "https://api.github.com/users/octo-org/events{/privacy}", "received_events_url": "https://api.github.com/users/octo-org/received_events", "type": "Organization", "site_admin": false }, "repository_selection": "selected", "access_tokens_url": "https://api.github.com/app/installations/25381/access_tokens", "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/octo-org/settings/installations/25381", "app_id": 2218, "target_id": 6811672, "target_type": "Organization", "permissions": { "deployments": "write", "metadata": "read", "pull_requests": "read", "statuses": "read" }, "events": [ "deployment", "deployment_status" ], "created_at": "2017-05-16T08:47:09.000-07:00", "updated_at": "2017-06-06T11:23:23.000-07:00", "single_file_name": "config.yml", "has_multiple_single_files": true, "single_file_paths": [ "config.yml", ".github/issue_TEMPLATE.md" ], "app_slug": "github-actions", "suspended_at": null, "suspended_by": null } ] }, "schema": { "type": "object", "required": [ "total_count", "installations" ], "properties": { "total_count": { "type": "integer" }, "installations": { "type": "array", "items": { "title": "Installation", "description": "Installation", "type": "object", "properties": { "id": { "description": "The ID of the installation.", "type": "integer", "examples": [ 1 ] }, "account": { "anyOf": [ { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise account", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/enterprises/octo-business" ] }, "website_url": { "description": "The enterprise's website URL.", "type": [ "string", "null" ], "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the enterprise.", "type": "string", "examples": [ "Octo Business" ] }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "examples": [ "octo-business" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2019-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2019-01-26T19:14:43Z" ] }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ], "type": [ "null", "object" ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "access_tokens_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/installations/1/access_tokens" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/installation/repositories" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/organizations/github/settings/installations/1" ] }, "app_id": { "type": "integer", "examples": [ 1 ] }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" }, "target_type": { "type": "string", "examples": [ "Organization" ] }, "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user-to-server access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", "enum": [ "read", "write" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "events": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "single_file_name": { "type": [ "string", "null" ], "examples": [ "config.yaml" ] }, "has_multiple_single_files": { "type": "boolean", "examples": [ true ] }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "examples": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "app_slug": { "type": "string", "examples": [ "github-actions" ] }, "suspended_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "contact_email": { "type": [ "string", "null" ], "examples": [ "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] } }, "required": [ "id", "app_id", "app_slug", "target_id", "target_type", "single_file_name", "repository_selection", "access_tokens_url", "html_url", "repositories_url", "events", "account", "permissions", "created_at", "updated_at", "suspended_by", "suspended_at" ] } } } } } } ], "previews": [], "descriptionHTML": "Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.
OK
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/{security_product}/{enablement}", "title": "Enable or disable a security feature for an organization", "category": "orgs", "subcategory": "orgs", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "security_product", "in": "path", "description": "The security feature to enable or disable.
", "required": true, "schema": { "type": "string", "enum": [ "dependency_graph", "dependabot_alerts", "dependabot_security_updates", "advanced_security", "secret_scanning", "secret_scanning_push_protection" ] } }, { "name": "enablement", "in": "path", "description": "The action to take.
\nenable_all means to enable the specified security feature for all repositories in the organization.\ndisable_all means to disable the specified security feature for all repositories in the organization.
Action started
" } } ], "previews": [], "descriptionHTML": "Enables or disables the specified security feature for all repositories in an organization.
\nTo use this endpoint, you must be an organization owner or be member of a team with the security manager role.\nA token with the 'write:org' scope is also required.
\nGitHub Apps must have the organization_administration:write permission to use this endpoint.
For more information, see \"Managing security managers in your organization.\"
", "statusCodes": [ { "httpStatusCode": "204", "description": "Action started
" }, { "httpStatusCode": "422", "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/orgs", "title": "List organizations for the authenticated user", "category": "orgs", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" } ], "schema": { "type": "array", "items": { "title": "Organization Simple", "description": "Organization Simple", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] } } } } ], "previews": [], "descriptionHTML": "List organizations for the authenticated user.
\nOAuth scope requirements
\nThis only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope. OAuth requests with insufficient scope receive a 403 Forbidden response.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/orgs", "title": "List organizations for a user", "category": "orgs", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" } ], "schema": { "type": "array", "items": { "title": "Organization Simple", "description": "Organization Simple", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] } } } } ], "previews": [], "descriptionHTML": "List public organization memberships for the specified user.
\nThis method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "orgs" } ], "blocking": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/blocks", "title": "List users blocked by an organization", "category": "orgs", "subcategory": "blocking", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "List the users blocked by an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/blocks/{username}", "title": "Check if a user is blocked by an organization", "category": "orgs", "subcategory": "blocking", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "If the user is blocked
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "If the user is blocked
" }, { "httpStatusCode": "404", "description": "If the user is not blocked
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/blocks/{username}", "title": "Block a user from an organization", "category": "orgs", "subcategory": "blocking", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/blocks/{username}", "title": "Unblock a user from an organization", "category": "orgs", "subcategory": "blocking", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ], "custom-roles": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/organizations/{organization_id}/custom_roles", "title": "List custom repository roles in an organization", "category": "orgs", "subcategory": "custom-roles", "parameters": [ { "name": "organization_id", "description": "The unique identifier of the organization.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "organization_id": "ORGANIZATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response - list of custom role names
", "example": { "total_count": 2, "custom_roles": [ { "id": 8030, "name": "Security Engineer", "description": "Able to contribute code and maintain the security pipeline", "base_role": "maintain", "permissions": [ "delete_alerts_code_scanning" ], "organization": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "created_at": "2022-07-04T22:19:11Z", "updated_at": "2022-07-04T22:20:11Z" }, { "id": 8031, "name": "Community manager", "description": "Able to handle all the community interactions without being able to contribute code", "base_role": "read", "permissions": [ "mark_as_duplicate", "manage_settings_pages", "manage_settings_wiki", "set_social_preview", "edit_repo_metadata", "toggle_discussion_comment_minimize" ], "organization": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "created_at": "2022-07-05T12:01:11Z", "updated_at": "2022-07-05T12:20:11Z" } ] }, "schema": { "type": "object", "properties": { "total_count": { "description": "The number of custom roles in this organization", "type": "integer", "examples": [ 3 ] }, "custom_roles": { "type": "array", "items": { "title": "Organization Custom Repository Role", "description": "Custom repository roles created by organization administrators", "type": "object", "properties": { "id": { "description": "The unique identifier of the custom role.", "type": "integer" }, "name": { "description": "The name of the custom role.", "type": "string" }, "description": { "description": "A short description about who this role is for or what permissions it grants.", "type": [ "string", "null" ] }, "base_role": { "type": "string", "description": "The system role from which this role inherits permissions.", "enum": [ "read", "triage", "write", "maintain" ] }, "permissions": { "description": "A list of additional permissions included in this role.", "type": "array", "items": { "type": "string" } }, "organization": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name" ] } } } } } } ], "previews": [], "descriptionHTML": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.
\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with admin:org repo scope.\nGitHub Apps must have the organization_custom_roles:read organization permission to use this endpoint.
For more information on custom repository roles, see \"Managing custom repository roles for an organization\".
", "statusCodes": [ { "httpStatusCode": "200", "description": "Response - list of custom role names
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/custom_roles", "title": "Create a custom role", "category": "orgs", "subcategory": "custom-roles", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name of the custom role.
", "isRequired": true }, { "type": "string", "name": "description", "in": "body", "description": "A short description about the intended usage of this role or what permissions it grants.
" }, { "type": "string", "name": "base_role", "in": "body", "description": "The system role from which this role inherits permissions.
", "isRequired": true, "enum": [ "read", "triage", "write", "maintain" ] }, { "type": "array of strings", "name": "permissions", "in": "body", "description": "A list of additional permissions included in this role.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Labeler", "description": "A role for issue and PR labelers", "base_role": "read", "permissions": [ "add_label" ] }, "parameters": { "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 8030, "name": "Labeler", "description": "A role for issue and PR labelers", "base_role": "read", "permissions": [ "add_label" ], "organization": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "created_at": "2022-07-04T22:19:11Z", "updated_at": "2022-07-04T22:19:11Z" }, "schema": { "title": "Organization Custom Repository Role", "description": "Custom repository roles created by organization administrators", "type": "object", "properties": { "id": { "description": "The unique identifier of the custom role.", "type": "integer" }, "name": { "description": "The name of the custom role.", "type": "string" }, "description": { "description": "A short description about who this role is for or what permissions it grants.", "type": [ "string", "null" ] }, "base_role": { "type": "string", "description": "The system role from which this role inherits permissions.", "enum": [ "read", "triage", "write", "maintain" ] }, "permissions": { "description": "A list of additional permissions included in this role.", "type": "array", "items": { "type": "string" } }, "organization": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name" ] } } } ], "previews": [], "descriptionHTML": "Note: This operation is in beta and is subject to change.
\nCreates a custom repository role that can be used by all repositories owned by the organization.
\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with admin:org scope.\nGitHub Apps must have the organization_custom_roles:write organization permission to use this endpoint.
For more information on custom repository roles, see \"Managing custom repository roles for an organization.\"
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/custom_roles/{role_id}", "title": "Update a custom role", "category": "orgs", "subcategory": "custom-roles", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role_id", "description": "The unique identifier of the role.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name of the custom role.
" }, { "type": "string", "name": "description", "in": "body", "description": "A short description about who this role is for or what permissions it grants.
" }, { "type": "string", "name": "base_role", "in": "body", "description": "The system role from which this role inherits permissions.
", "enum": [ "read", "triage", "write", "maintain" ] }, { "type": "array of strings", "name": "permissions", "in": "body", "description": "A list of additional permissions included in this role. If specified, these permissions will replace any currently set on the role.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Labeler", "description": "A role for issue and PR labelers", "base_role": "read", "permissions": [ "add_label", "remove_label" ] }, "parameters": { "org": "ORG", "role_id": "ROLE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 8030, "name": "Labeler", "description": "A role for issue and PR labelers", "base_role": "read", "permissions": [ "add_label", "remove_label" ], "organization": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "created_at": "2022-07-04T22:19:11Z", "updated_at": "2022-07-04T22:19:11Z" }, "schema": { "title": "Organization Custom Repository Role", "description": "Custom repository roles created by organization administrators", "type": "object", "properties": { "id": { "description": "The unique identifier of the custom role.", "type": "integer" }, "name": { "description": "The name of the custom role.", "type": "string" }, "description": { "description": "A short description about who this role is for or what permissions it grants.", "type": [ "string", "null" ] }, "base_role": { "type": "string", "description": "The system role from which this role inherits permissions.", "enum": [ "read", "triage", "write", "maintain" ] }, "permissions": { "description": "A list of additional permissions included in this role.", "type": "array", "items": { "type": "string" } }, "organization": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name" ] } } } ], "previews": [], "descriptionHTML": "Note: This operation is in beta and subject to change.
\nUpdates a custom repository role that can be used by all repositories owned by the organization.
\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with admin:org scope.\nGitHub Apps must have the organization_custom_roles:write organization permission to use this endpoint.
For more information about custom repository roles, see \"Managing custom repository roles for an organization.\"
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/custom_roles/{role_id}", "title": "Delete a custom role", "category": "orgs", "subcategory": "custom-roles", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role_id", "description": "The unique identifier of the role.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "role_id": "ROLE_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: This operation is in beta and is subject to change.
\nDeletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role.
\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with admin:org scope.\nGitHub Apps must have the organization_custom_roles:write organization permission to use this endpoint.
For more information about custom repository roles, see \"Managing custom repository roles for an organization.\"
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/fine_grained_permissions", "title": "List fine-grained permissions for an organization", "category": "orgs", "subcategory": "custom-roles", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "name": "add_assignee", "description": "Assign or remove a user" }, { "name": "remove_assignee", "description": "Remove an assigned user" }, { "name": "add_label", "description": "Add or remove a label" } ], "schema": { "type": "array", "items": { "title": "Organization Fine-Grained Permission", "description": "Fine-grained permissions available for the organization", "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "name", "description" ] } } } } ], "previews": [], "descriptionHTML": "Note: This operation is in beta and subject to change.
\nLists the fine-grained permissions available for an organization.
\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with admin:org repo scope.\nGitHub Apps must have the organization_custom_roles:read organization permission to use this endpoint.
OK
" } ] } ], "members": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/failed_invitations", "title": "List failed organization invitations", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "login": "monalisa", "node_id": "MDQ6VXNlcjE=", "email": "octocat@github.com", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", "failed_at": "", "failed_reason": "", "inviter": { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, "team_count": 2, "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams" } ], "schema": { "type": "array", "items": { "title": "Organization Invitation", "description": "Organization Invitation", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "role": { "type": "string" }, "created_at": { "type": "string" }, "failed_at": { "type": [ "string", "null" ] }, "failed_reason": { "type": [ "string", "null" ] }, "inviter": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "team_count": { "type": "integer" }, "node_id": { "type": "string", "examples": [ "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" ] }, "invitation_teams_url": { "type": "string", "examples": [ "\"https://api.github.com/organizations/16/invitations/1/teams\"" ] } }, "required": [ "id", "login", "email", "role", "created_at", "inviter", "team_count", "invitation_teams_url", "node_id" ] } } } } ], "previews": [], "descriptionHTML": "The return hash contains failed_at and failed_reason fields which represent the time at which the invitation failed and the reason for the failure.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/invitations", "title": "List pending organization invitations", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "login": "monalisa", "node_id": "MDQ6VXNlcjE=", "email": "octocat@github.com", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", "failed_at": "", "failed_reason": "", "inviter": { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, "team_count": 2, "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams" } ], "schema": { "type": "array", "items": { "title": "Organization Invitation", "description": "Organization Invitation", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "role": { "type": "string" }, "created_at": { "type": "string" }, "failed_at": { "type": [ "string", "null" ] }, "failed_reason": { "type": [ "string", "null" ] }, "inviter": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "team_count": { "type": "integer" }, "node_id": { "type": "string", "examples": [ "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" ] }, "invitation_teams_url": { "type": "string", "examples": [ "\"https://api.github.com/organizations/16/invitations/1/teams\"" ] } }, "required": [ "id", "login", "email", "role", "created_at", "inviter", "team_count", "invitation_teams_url", "node_id" ] } } } } ], "previews": [], "descriptionHTML": "The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/invitations", "title": "Create an organization invitation", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "integer", "name": "invitee_id", "in": "body", "description": "Required unless you provide email. GitHub user ID for the person you are inviting.
Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.
The role for the new member.\n* admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.
\n* direct_member - Non-owner organization members with ability to see other members and join teams by invitation.
\n* billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.
Specify IDs for the teams you want to invite new members to.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "email": "octocat@github.com", "role": "direct_member", "team_ids": [ 12, 26 ] }, "parameters": { "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "login": "monalisa", "node_id": "MDQ6VXNlcjE=", "email": "octocat@github.com", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", "inviter": { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, "team_count": 2, "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams" }, "schema": { "title": "Organization Invitation", "description": "Organization Invitation", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "role": { "type": "string" }, "created_at": { "type": "string" }, "failed_at": { "type": [ "string", "null" ] }, "failed_reason": { "type": [ "string", "null" ] }, "inviter": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "team_count": { "type": "integer" }, "node_id": { "type": "string", "examples": [ "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" ] }, "invitation_teams_url": { "type": "string", "examples": [ "\"https://api.github.com/organizations/16/invitations/1/teams\"" ] } }, "required": [ "id", "login", "email", "role", "created_at", "inviter", "team_count", "invitation_teams_url", "node_id" ] } } } ], "previews": [], "descriptionHTML": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/invitations/{invitation_id}", "title": "Cancel an organization invitation", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invitation_id", "description": "The unique identifier of the invitation.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "invitation_id": "INVITATION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.
\nThis endpoint triggers notifications.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/invitations/{invitation_id}/teams", "title": "List organization invitation teams", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invitation_id", "description": "The unique identifier of the invitation.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "invitation_id": "INVITATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "schema": { "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } } } } ], "previews": [], "descriptionHTML": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/members", "title": "List organization members", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filter", "description": "Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.
Filter members returned by their role.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "admin", "member" ], "default": "all" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/members/{username}", "title": "Check organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response if requester is an organization member and user is a member
" } } ], "previews": [], "descriptionHTML": "Check if a user is, publicly or privately, a member of the organization.
", "statusCodes": [ { "httpStatusCode": "204", "description": "Response if requester is an organization member and user is a member
" }, { "httpStatusCode": "302", "description": "Response if requester is not an organization member
" }, { "httpStatusCode": "404", "description": "Not Found if requester is an organization member and user is not a member
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/members/{username}", "title": "Remove an organization member", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/memberships/{username}", "title": "Get organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if user has an active admin membership with organization
", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", "role": "admin", "organization_url": "https://api.github.com/orgs/octocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, "schema": { "title": "Org Membership", "description": "Org Membership", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/memberships/defunkt" ] }, "state": { "type": "string", "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", "enum": [ "active", "pending" ], "examples": [ "active" ] }, "role": { "type": "string", "description": "The user's membership type in the organization.", "enum": [ "admin", "member", "billing_manager" ], "examples": [ "admin" ] }, "organization_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat" ] }, "organization": { "title": "Organization Simple", "description": "Organization Simple", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "permissions": { "type": "object", "properties": { "can_create_repository": { "type": "boolean" } }, "required": [ "can_create_repository" ] } }, "required": [ "state", "role", "organization_url", "url", "organization", "user" ] } } } ], "previews": [], "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.
OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/memberships/{username}", "title": "Set organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "role", "in": "body", "description": "The role to give the user in the organization. Can be one of:
\n* admin - The user will become an owner of the organization.
\n* member - The user will become a non-owner member of the organization.
Response if user has an active admin membership with organization
", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", "role": "admin", "organization_url": "https://api.github.com/orgs/octocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, "schema": { "title": "Org Membership", "description": "Org Membership", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/memberships/defunkt" ] }, "state": { "type": "string", "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", "enum": [ "active", "pending" ], "examples": [ "active" ] }, "role": { "type": "string", "description": "The user's membership type in the organization.", "enum": [ "admin", "member", "billing_manager" ], "examples": [ "admin" ] }, "organization_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat" ] }, "organization": { "title": "Organization Simple", "description": "Organization Simple", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "permissions": { "type": "object", "properties": { "can_create_repository": { "type": "boolean" } }, "required": [ "can_create_repository" ] } }, "required": [ "state", "role", "organization_url", "url", "organization", "user" ] } } } ], "previews": [], "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\n- \n
- If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be
pendinguntil they accept the invitation. \n - Authenticated users can update a user's membership by passing the
roleparameter. If the authenticated user changes a member's role toadmin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role tomember, no email will be sent. \n
Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/memberships/{username}", "title": "Remove organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/public_members", "title": "List public organization members", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Members of an organization can choose to have their membership publicized or not.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/public_members/{username}", "title": "Check public organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response if user is a public member
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "Response if user is a public member
" }, { "httpStatusCode": "404", "description": "Not Found if user is not a public member
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/public_members/{username}", "title": "Set public organization membership for the authenticated user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/public_members/{username}", "title": "Remove public organization membership for the authenticated user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/memberships/orgs", "title": "List organization memberships for the authenticated user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "state", "description": "Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", "role": "admin", "organization_url": "https://api.github.com/orgs/octocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, { "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", "state": "pending", "role": "admin", "organization_url": "https://api.github.com/orgs/invitocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } ], "schema": { "type": "array", "items": { "title": "Org Membership", "description": "Org Membership", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/memberships/defunkt" ] }, "state": { "type": "string", "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", "enum": [ "active", "pending" ], "examples": [ "active" ] }, "role": { "type": "string", "description": "The user's membership type in the organization.", "enum": [ "admin", "member", "billing_manager" ], "examples": [ "admin" ] }, "organization_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat" ] }, "organization": { "title": "Organization Simple", "description": "Organization Simple", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "permissions": { "type": "object", "properties": { "can_create_repository": { "type": "boolean" } }, "required": [ "can_create_repository" ] } }, "required": [ "state", "role", "organization_url", "url", "organization", "user" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/memberships/orgs/{org}", "title": "Get an organization membership for the authenticated user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", "state": "pending", "role": "admin", "organization_url": "https://api.github.com/orgs/invitocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, "schema": { "title": "Org Membership", "description": "Org Membership", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/memberships/defunkt" ] }, "state": { "type": "string", "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", "enum": [ "active", "pending" ], "examples": [ "active" ] }, "role": { "type": "string", "description": "The user's membership type in the organization.", "enum": [ "admin", "member", "billing_manager" ], "examples": [ "admin" ] }, "organization_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat" ] }, "organization": { "title": "Organization Simple", "description": "Organization Simple", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "permissions": { "type": "object", "properties": { "can_create_repository": { "type": "boolean" } }, "required": [ "can_create_repository" ] } }, "required": [ "state", "role", "organization_url", "url", "organization", "user" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/user/memberships/orgs/{org}", "title": "Update an organization membership for the authenticated user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "state", "in": "body", "description": "The state that the membership should be in. Only \"active\" will be accepted.
Response
", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", "role": "admin", "organization_url": "https://api.github.com/orgs/octocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, "schema": { "title": "Org Membership", "description": "Org Membership", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/memberships/defunkt" ] }, "state": { "type": "string", "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", "enum": [ "active", "pending" ], "examples": [ "active" ] }, "role": { "type": "string", "description": "The user's membership type in the organization.", "enum": [ "admin", "member", "billing_manager" ], "examples": [ "admin" ] }, "organization_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat" ] }, "organization": { "title": "Organization Simple", "description": "Organization Simple", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "permissions": { "type": "object", "properties": { "can_create_repository": { "type": "boolean" } }, "required": [ "can_create_repository" ] } }, "required": [ "state", "role", "organization_url", "url", "organization", "user" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "outside-collaborators": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/outside_collaborators", "title": "List outside collaborators for an organization", "category": "orgs", "subcategory": "outside-collaborators", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filter", "description": "Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "List all users who are outside collaborators of an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/outside_collaborators/{username}", "title": "Convert an organization member to outside collaborator", "category": "orgs", "subcategory": "outside-collaborators", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "boolean", "name": "async", "in": "body", "description": "When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.
User is getting converted asynchronously
", "example": null, "schema": { "type": "object", "properties": {}, "additionalProperties": false } } }, { "key": "204", "request": { "contentType": "application/json", "description": "Status code 204, synchronous request", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": null, "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "User was converted
" } } ], "previews": [], "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
", "statusCodes": [ { "httpStatusCode": "202", "description": "User is getting converted asynchronously
" }, { "httpStatusCode": "204", "description": "User was converted
" }, { "httpStatusCode": "403", "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}", "title": "Remove outside collaborator from an organization", "category": "orgs", "subcategory": "outside-collaborators", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "422", "description": "Unprocessable Entity if user is a member of the organization
" } ] } ], "security-managers": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/security-managers", "title": "List security manager teams", "category": "orgs", "subcategory": "security-managers", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "schema": { "type": "array", "items": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } } } } ], "previews": [], "descriptionHTML": "Lists teams that are security managers for an organization. For more information, see \"Managing security managers in your organization.\"
\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the read:org scope.
GitHub Apps must have the administration organization read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}", "title": "Add a security manager team", "category": "orgs", "subcategory": "security-managers", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"
\nTo use this endpoint, you must be an administrator for the organization, and you must use an access token with the write:org scope.
GitHub Apps must have the administration organization read-write permission to use this endpoint.
No Content
" }, { "httpStatusCode": "409", "description": "The organization has reached the maximum number of security manager teams.
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}", "title": "Remove a security manager team", "category": "orgs", "subcategory": "security-managers", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes the security manager role from a team for an organization. For more information, see \"Managing security managers in your organization team from an organization.\"
\nTo use this endpoint, you must be an administrator for the organization, and you must use an access token with the admin:org scope.
GitHub Apps must have the administration organization read-write permission to use this endpoint.
No Content
" } ] } ], "webhooks": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/hooks", "title": "List organization webhooks", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", "name": "web", "events": [ "push", "pull_request" ], "active": true, "config": { "url": "http://example.com", "content_type": "json" }, "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "type": "Organization" } ], "schema": { "type": "array", "items": { "title": "Org Hook", "description": "Org Hook", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/hooks/1" ] }, "ping_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/hooks/1/pings" ] }, "deliveries_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/hooks/1/deliveries" ] }, "name": { "type": "string", "examples": [ "web" ] }, "events": { "type": "array", "items": { "type": "string" }, "examples": [ "push", "pull_request" ] }, "active": { "type": "boolean", "examples": [ true ] }, "config": { "type": "object", "properties": { "url": { "type": "string", "examples": [ "\"http://example.com/2\"" ] }, "insecure_ssl": { "type": "string", "examples": [ "\"0\"" ] }, "content_type": { "type": "string", "examples": [ "\"form\"" ] }, "secret": { "type": "string", "examples": [ "\"********\"" ] } } }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T20:39:23Z" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T17:26:27Z" ] }, "type": { "type": "string" } }, "required": [ "id", "url", "type", "name", "active", "events", "config", "ping_url", "created_at", "updated_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/hooks", "title": "Create an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "Must be passed as \"web\".
", "isRequired": true }, { "type": "object", "name": "config", "in": "body", "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "url", "description": "The URL to which the payloads will be delivered.
", "isRequired": true }, { "type": "string", "name": "content_type", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
Determines what events the hook is triggered for.
", "default": [ "push" ] }, { "type": "boolean", "name": "active", "in": "body", "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Response
", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", "name": "web", "events": [ "push", "pull_request" ], "active": true, "config": { "url": "http://example.com", "content_type": "json" }, "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "type": "Organization" }, "schema": { "title": "Org Hook", "description": "Org Hook", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/hooks/1" ] }, "ping_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/hooks/1/pings" ] }, "deliveries_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/hooks/1/deliveries" ] }, "name": { "type": "string", "examples": [ "web" ] }, "events": { "type": "array", "items": { "type": "string" }, "examples": [ "push", "pull_request" ] }, "active": { "type": "boolean", "examples": [ true ] }, "config": { "type": "object", "properties": { "url": { "type": "string", "examples": [ "\"http://example.com/2\"" ] }, "insecure_ssl": { "type": "string", "examples": [ "\"0\"" ] }, "content_type": { "type": "string", "examples": [ "\"form\"" ] }, "secret": { "type": "string", "examples": [ "\"********\"" ] } } }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T20:39:23Z" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T17:26:27Z" ] }, "type": { "type": "string" } }, "required": [ "id", "url", "type", "name", "active", "events", "config", "ping_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Here's how you can create a hook that posts payloads in JSON format:
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}", "title": "Get an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", "name": "web", "events": [ "push", "pull_request" ], "active": true, "config": { "url": "http://example.com", "content_type": "json" }, "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "type": "Organization" }, "schema": { "title": "Org Hook", "description": "Org Hook", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/hooks/1" ] }, "ping_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/hooks/1/pings" ] }, "deliveries_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/hooks/1/deliveries" ] }, "name": { "type": "string", "examples": [ "web" ] }, "events": { "type": "array", "items": { "type": "string" }, "examples": [ "push", "pull_request" ] }, "active": { "type": "boolean", "examples": [ true ] }, "config": { "type": "object", "properties": { "url": { "type": "string", "examples": [ "\"http://example.com/2\"" ] }, "insecure_ssl": { "type": "string", "examples": [ "\"0\"" ] }, "content_type": { "type": "string", "examples": [ "\"form\"" ] }, "secret": { "type": "string", "examples": [ "\"********\"" ] } } }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T20:39:23Z" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T17:26:27Z" ] }, "type": { "type": "string" } }, "required": [ "id", "url", "type", "name", "active", "events", "config", "ping_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Returns a webhook configured in an organization. To get only the webhook config properties, see \"Get a webhook configuration for an organization.\"
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/hooks/{hook_id}", "title": "Update an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "object", "name": "config", "in": "body", "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "The URL to which the payloads will be delivered.
", "isRequired": true }, { "type": "string", "name": "content_type", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
Determines what events the hook is triggered for.
", "default": [ "push" ] }, { "type": "boolean", "name": "active", "in": "body", "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Response
", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "name": "web", "events": [ "pull_request" ], "active": true, "config": { "url": "http://example.com", "content_type": "json" }, "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "type": "Organization" }, "schema": { "title": "Org Hook", "description": "Org Hook", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/hooks/1" ] }, "ping_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/hooks/1/pings" ] }, "deliveries_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/octocat/hooks/1/deliveries" ] }, "name": { "type": "string", "examples": [ "web" ] }, "events": { "type": "array", "items": { "type": "string" }, "examples": [ "push", "pull_request" ] }, "active": { "type": "boolean", "examples": [ true ] }, "config": { "type": "object", "properties": { "url": { "type": "string", "examples": [ "\"http://example.com/2\"" ] }, "insecure_ssl": { "type": "string", "examples": [ "\"0\"" ] }, "content_type": { "type": "string", "examples": [ "\"form\"" ] }, "secret": { "type": "string", "examples": [ "\"********\"" ] } } }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T20:39:23Z" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T17:26:27Z" ] }, "type": { "type": "string" } }, "required": [ "id", "url", "type", "name", "active", "events", "config", "ping_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for an organization.\"
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/hooks/{hook_id}", "title": "Delete an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}/config", "title": "Get a webhook configuration for an organization", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" }, "schema": { "title": "Webhook Configuration", "description": "Configuration object of the webhook", "type": "object", "properties": { "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "format": "uri", "examples": [ "https://example.com/webhook" ] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ "\"json\"" ] }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "examples": [ "\"0\"" ] }, { "type": "number" } ] } } } } } ], "previews": [], "descriptionHTML": "Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"
Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:read permission.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/hooks/{hook_id}/config", "title": "Update a webhook configuration for an organization", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "url", "in": "body", "description": "The URL to which the payloads will be delivered.
" }, { "type": "string", "name": "content_type", "in": "body", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
Response
", "example": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" }, "schema": { "title": "Webhook Configuration", "description": "Configuration object of the webhook", "type": "object", "properties": { "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "format": "uri", "examples": [ "https://example.com/webhook" ] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ "\"json\"" ] }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "examples": [ "\"0\"" ] }, { "type": "number" } ] } } } } } ], "previews": [], "descriptionHTML": "Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"
Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries", "title": "List deliveries for an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "cursor", "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link header for the next and previous page cursors.
Response
", "example": [ { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-03T00:57:16Z", "redelivery": false, "duration": 0.27, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456 }, { "id": 123456789, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-04T00:57:16Z", "redelivery": true, "duration": 0.28, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456 } ], "schema": { "type": "array", "items": { "title": "Simple webhook delivery", "description": "Delivery made by a webhook, without request and response information.", "type": "object", "properties": { "id": { "description": "Unique identifier of the webhook delivery.", "type": "integer", "examples": [ 42 ] }, "guid": { "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", "type": "string", "examples": [ "58474f00-b361-11eb-836d-0e4f3503ccbe" ] }, "delivered_at": { "description": "Time when the webhook delivery occurred.", "type": "string", "format": "date-time", "examples": [ "2021-05-12T20:33:44Z" ] }, "redelivery": { "description": "Whether the webhook delivery is a redelivery.", "type": "boolean", "examples": [ false ] }, "duration": { "description": "Time spent delivering.", "type": "number", "examples": [ 0.03 ] }, "status": { "description": "Describes the response returned after attempting the delivery.", "type": "string", "examples": [ "failed to connect" ] }, "status_code": { "description": "Status code received when delivery was made.", "type": "integer", "examples": [ 502 ] }, "event": { "description": "The event that triggered the delivery.", "type": "string", "examples": [ "issues" ] }, "action": { "description": "The type of activity for the event that triggered the delivery.", "type": [ "string", "null" ], "examples": [ "opened" ] }, "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": [ "integer", "null" ], "examples": [ 123 ] }, "repository_id": { "description": "The id of the repository associated with this event.", "type": [ "integer", "null" ], "examples": [ 123 ] } }, "required": [ "id", "guid", "delivered_at", "redelivery", "duration", "status", "status_code", "event", "action", "installation_id", "repository_id" ] } } } } ], "previews": [], "descriptionHTML": "Returns a list of webhook deliveries for a webhook configured in an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}", "title": "Get a webhook delivery for an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "hook_id": "HOOK_ID", "delivery_id": "DELIVERY_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-03T00:57:16Z", "redelivery": false, "duration": 0.27, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456, "url": "https://www.example.com", "request": { "headers": { "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "Accept": "*/*", "X-GitHub-Hook-ID": "42", "User-Agent": "GitHub-Hookshot/b8c71d8", "X-GitHub-Event": "issues", "X-GitHub-Hook-Installation-Target-ID": "123", "X-GitHub-Hook-Installation-Target-Type": "repository", "content-type": "application/json", "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" }, "payload": { "action": "opened", "issue": { "body": "foo" }, "repository": { "id": 123 } } }, "response": { "headers": { "Content-Type": "text/html;charset=utf-8" }, "payload": "ok" } }, "schema": { "title": "Webhook delivery", "description": "Delivery made by a webhook.", "type": "object", "properties": { "id": { "description": "Unique identifier of the delivery.", "type": "integer", "examples": [ 42 ] }, "guid": { "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", "type": "string", "examples": [ "58474f00-b361-11eb-836d-0e4f3503ccbe" ] }, "delivered_at": { "description": "Time when the delivery was delivered.", "type": "string", "format": "date-time", "examples": [ "2021-05-12T20:33:44Z" ] }, "redelivery": { "description": "Whether the delivery is a redelivery.", "type": "boolean", "examples": [ false ] }, "duration": { "description": "Time spent delivering.", "type": "number", "examples": [ 0.03 ] }, "status": { "description": "Description of the status of the attempted delivery", "type": "string", "examples": [ "failed to connect" ] }, "status_code": { "description": "Status code received when delivery was made.", "type": "integer", "examples": [ 502 ] }, "event": { "description": "The event that triggered the delivery.", "type": "string", "examples": [ "issues" ] }, "action": { "description": "The type of activity for the event that triggered the delivery.", "type": [ "string", "null" ], "examples": [ "opened" ] }, "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": [ "integer", "null" ], "examples": [ 123 ] }, "repository_id": { "description": "The id of the repository associated with this event.", "type": [ "integer", "null" ], "examples": [ 123 ] }, "url": { "description": "The URL target of the delivery.", "type": "string", "examples": [ "https://www.example.com" ] }, "request": { "type": "object", "properties": { "headers": { "description": "The request headers sent with the webhook delivery.", "type": [ "object", "null" ], "additionalProperties": true }, "payload": { "description": "The webhook payload.", "type": [ "object", "null" ], "additionalProperties": true } }, "required": [ "headers", "payload" ] }, "response": { "type": "object", "properties": { "headers": { "description": "The response headers received when the delivery was made.", "type": [ "object", "null" ], "additionalProperties": true }, "payload": { "description": "The response payload received.", "type": [ "string", "null" ], "additionalProperties": true } }, "required": [ "headers", "payload" ] } }, "required": [ "id", "guid", "delivered_at", "redelivery", "duration", "status", "status_code", "event", "action", "installation_id", "repository_id", "request", "response" ] } } } ], "previews": [], "descriptionHTML": "Returns a delivery for a webhook configured in an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", "title": "Redeliver a delivery for an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "hook_id": "HOOK_ID", "delivery_id": "DELIVERY_ID" } }, "response": { "statusCode": "202", "description": "Accepted
" } } ], "previews": [], "descriptionHTML": "Redeliver a delivery for a webhook configured in an organization.
", "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", "title": "Ping an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "This will trigger a ping event to be sent to the hook.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ] }, "packages": { "packages": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/packages", "title": "List packages for an organization", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "visibility", "description": "The selected visibility of the packages. Only container package_types currently support internal visibility properly. For other ecosystems internal is synonymous with private. This parameter is optional and only filters an existing result set.
Response
", "example": [ { "id": 197, "name": "hello_docker", "package_type": "container", "owner": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "version_count": 1, "visibility": "private", "url": "https://api.github.com/orgs/github/packages/container/hello_docker", "created_at": "2020-05-19T22:19:11Z", "updated_at": "2020-05-19T22:19:11Z", "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" }, { "id": 198, "name": "goodbye_docker", "package_type": "container", "owner": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "version_count": 2, "visibility": "private", "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", "created_at": "2020-05-20T22:19:11Z", "updated_at": "2020-05-20T22:19:11Z", "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" } ], "schema": { "type": "array", "items": { "title": "Package", "description": "A software package", "type": "object", "properties": { "id": { "description": "Unique identifier of the package.", "type": "integer", "examples": [ 1 ] }, "name": { "description": "The name of the package.", "type": "string", "examples": [ "super-linter" ] }, "package_type": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ], "examples": [ "docker" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/packages/container/super-linter" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/package/super-linter" ] }, "version_count": { "description": "The number of versions of the package.", "type": "integer", "examples": [ 1 ] }, "visibility": { "type": "string", "enum": [ "private", "public" ], "examples": [ "private" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "repository": { "anyOf": [ { "type": "null" }, { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "package_type", "visibility", "url", "html_url", "version_count", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists all packages in an organization readable by the user.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}", "title": "Get a package for an organization", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 197, "name": "hello_docker", "package_type": "container", "owner": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "version_count": 1, "visibility": "private", "url": "https://api.github.com/orgs/github/packages/container/hello_docker", "created_at": "2020-05-19T22:19:11Z", "updated_at": "2020-05-19T22:19:11Z", "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" }, "schema": { "title": "Package", "description": "A software package", "type": "object", "properties": { "id": { "description": "Unique identifier of the package.", "type": "integer", "examples": [ 1 ] }, "name": { "description": "The name of the package.", "type": "string", "examples": [ "super-linter" ] }, "package_type": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ], "examples": [ "docker" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/packages/container/super-linter" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/package/super-linter" ] }, "version_count": { "description": "The number of versions of the package.", "type": "integer", "examples": [ 1 ] }, "visibility": { "type": "string", "enum": [ "private", "public" ], "examples": [ "private" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "repository": { "anyOf": [ { "type": "null" }, { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "package_type", "visibility", "url", "html_url", "version_count", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific package in an organization.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}", "title": "Delete a package for an organization", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:delete scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container you want to delete. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/restore", "title": "Restore a package for an organization", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "token", "description": "package token
", "schema": { "type": "string" }, "required": false, "in": "query" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Restores an entire package in an organization.
\nYou can restore a deleted package under the following conditions:
\n- \n
- The package was deleted within the last 30 days. \n
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. \n
To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:write scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container that you want to restore. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions", "title": "List package versions for a package owned by an organization", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "state", "in": "query", "required": false, "description": "The state of the package, either active or deleted.
", "schema": { "type": "string", "enum": [ "active", "deleted" ], "default": "active" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 245301, "name": "1.0.4", "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/245301", "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", "created_at": "2019-11-05T22:49:04Z", "updated_at": "2019-11-05T22:49:04Z", "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.4", "metadata": { "package_type": "npm" } }, { "id": 209672, "name": "1.0.3", "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/209672", "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", "created_at": "2019-10-29T15:42:11Z", "updated_at": "2019-10-29T15:42:12Z", "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.3", "metadata": { "package_type": "npm" } } ], "schema": { "type": "array", "items": { "title": "Package Version", "description": "A version of a software package", "type": "object", "properties": { "id": { "description": "Unique identifier of the package version.", "type": "integer", "examples": [ 1 ] }, "name": { "description": "The name of the package version.", "type": "string", "examples": [ "latest" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" ] }, "package_html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/package/super-linter" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/super-linter/786068" ] }, "license": { "type": "string", "examples": [ "MIT" ] }, "description": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "deleted_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "metadata": { "type": "object", "title": "Package Version Metadata", "properties": { "package_type": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ], "examples": [ "docker" ] }, "container": { "type": "object", "title": "Container Metadata", "properties": { "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "tags" ] }, "docker": { "type": "object", "title": "Docker Metadata", "properties": { "tag": { "type": "array", "items": { "type": "string" } } }, "required": [ "tags" ] } }, "required": [ "package_type" ] } }, "required": [ "id", "name", "url", "package_html_url", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists package versions for a package owned by an organization.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", "title": "Get a package version for an organization", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "package_version_id", "description": "Unique identifier of the package version.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 836, "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344", "url": "https://api.github.com/orgs/github/packages/container/hello_docker/versions/836", "package_html_url": "https://github.com/orgs/github/packages/container/package/hello_docker", "created_at": "2020-05-19T22:19:11Z", "updated_at": "2020-05-19T22:19:11Z", "html_url": "https://github.com/orgs/github/packages/container/hello_docker/836", "metadata": { "package_type": "container", "container": { "tags": [ "latest" ] } } }, "schema": { "title": "Package Version", "description": "A version of a software package", "type": "object", "properties": { "id": { "description": "Unique identifier of the package version.", "type": "integer", "examples": [ 1 ] }, "name": { "description": "The name of the package version.", "type": "string", "examples": [ "latest" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" ] }, "package_html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/package/super-linter" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/super-linter/786068" ] }, "license": { "type": "string", "examples": [ "MIT" ] }, "description": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "deleted_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "metadata": { "type": "object", "title": "Package Version Metadata", "properties": { "package_type": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ], "examples": [ "docker" ] }, "container": { "type": "object", "title": "Container Metadata", "properties": { "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "tags" ] }, "docker": { "type": "object", "title": "Docker Metadata", "properties": { "tag": { "type": "array", "items": { "type": "string" } } }, "required": [ "tags" ] } }, "required": [ "package_type" ] } }, "required": [ "id", "name", "url", "package_html_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific package version in an organization.
\nYou must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", "title": "Delete package version for an organization", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "package_version_id", "description": "Unique identifier of the package version.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:delete scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container you want to delete. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "title": "Restore package version for an organization", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "package_version_id", "description": "Unique identifier of the package version.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Restores a specific package version in an organization.
\nYou can restore a deleted package under the following conditions:
\n- \n
- The package was deleted within the last 30 days. \n
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. \n
To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:write scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container that you want to restore. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/packages", "title": "List packages for the authenticated user's namespace", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The selected visibility of the packages. Only container package_types currently support internal visibility properly. For other ecosystems internal is synonymous with private. This parameter is optional and only filters an existing result set.
Response
", "example": [ { "id": 197, "name": "hello_docker", "package_type": "container", "owner": { "login": "monalisa", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.monalisausercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "User", "site_admin": false }, "version_count": 1, "visibility": "private", "url": "https://api.github.com/orgs/github/packages/container/hello_docker", "created_at": "2020-05-19T22:19:11Z", "updated_at": "2020-05-19T22:19:11Z", "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" }, { "id": 198, "name": "goodbye_docker", "package_type": "container", "owner": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "User", "site_admin": false }, "version_count": 2, "visibility": "private", "url": "https://api.github.com/user/monalisa/packages/container/goodbye_docker", "created_at": "2020-05-20T22:19:11Z", "updated_at": "2020-05-20T22:19:11Z", "html_url": "https://github.com/user/monalisa/packages/container/package/goodbye_docker" } ], "schema": { "type": "array", "items": { "title": "Package", "description": "A software package", "type": "object", "properties": { "id": { "description": "Unique identifier of the package.", "type": "integer", "examples": [ 1 ] }, "name": { "description": "The name of the package.", "type": "string", "examples": [ "super-linter" ] }, "package_type": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ], "examples": [ "docker" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/packages/container/super-linter" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/package/super-linter" ] }, "version_count": { "description": "The number of versions of the package.", "type": "integer", "examples": [ 1 ] }, "visibility": { "type": "string", "enum": [ "private", "public" ], "examples": [ "private" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "repository": { "anyOf": [ { "type": "null" }, { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "package_type", "visibility", "url", "html_url", "version_count", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists packages owned by the authenticated user within the user's namespace.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/packages/{package_type}/{package_name}", "title": "Get a package for the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 40201, "name": "octo-name", "package_type": "rubygems", "owner": { "login": "octocat", "id": 209477, "node_id": "MDQ6VXNlcjIwOTQ3Nw==", "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "version_count": 3, "visibility": "public", "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name", "created_at": "2019-10-20T14:17:14Z", "updated_at": "2019-10-20T14:17:14Z", "repository": { "id": 216219492, "node_id": "MDEwOlJlcG9zaXRvcnkyMTYyMTk0OTI=", "name": "octo-name-repo", "full_name": "octocat/octo-name-repo", "private": false, "owner": { "login": "octocat", "id": 209477, "node_id": "MDQ6VXNlcjIwOTQ3Nw==", "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "html_url": "https://github.com/octocat/octo-name-repo", "description": "Project for octocats", "fork": false, "url": "https://api.github.com/repos/octocat/octo-name-repo", "forks_url": "https://api.github.com/repos/octocat/octo-name-repo/forks", "keys_url": "https://api.github.com/repos/octocat/octo-name-repo/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/octocat/octo-name-repo/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/octocat/octo-name-repo/teams", "hooks_url": "https://api.github.com/repos/octocat/octo-name-repo/hooks", "issue_events_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/events{/number}", "events_url": "https://api.github.com/repos/octocat/octo-name-repo/events", "assignees_url": "https://api.github.com/repos/octocat/octo-name-repo/assignees{/user}", "branches_url": "https://api.github.com/repos/octocat/octo-name-repo/branches{/branch}", "tags_url": "https://api.github.com/repos/octocat/octo-name-repo/tags", "blobs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/octo-name-repo/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/refs{/sha}", "trees_url": "https://api.github.com/repos/octocat/octo-name-repo/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/octocat/octo-name-repo/statuses/{sha}", "languages_url": "https://api.github.com/repos/octocat/octo-name-repo/languages", "stargazers_url": "https://api.github.com/repos/octocat/octo-name-repo/stargazers", "contributors_url": "https://api.github.com/repos/octocat/octo-name-repo/contributors", "subscribers_url": "https://api.github.com/repos/octocat/octo-name-repo/subscribers", "subscription_url": "https://api.github.com/repos/octocat/octo-name-repo/subscription", "commits_url": "https://api.github.com/repos/octocat/octo-name-repo/commits{/sha}", "git_commits_url": "https://api.github.com/repos/octocat/octo-name-repo/git/commits{/sha}", "comments_url": "https://api.github.com/repos/octocat/octo-name-repo/comments{/number}", "issue_comment_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/comments{/number}", "contents_url": "https://api.github.com/repos/octocat/octo-name-repo/contents/{+path}", "compare_url": "https://api.github.com/repos/octocat/octo-name-repo/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/octocat/octo-name-repo/merges", "archive_url": "https://api.github.com/repos/octocat/octo-name-repo/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/octocat/octo-name-repo/downloads", "issues_url": "https://api.github.com/repos/octocat/octo-name-repo/issues{/number}", "pulls_url": "https://api.github.com/repos/octocat/octo-name-repo/pulls{/number}", "milestones_url": "https://api.github.com/repos/octocat/octo-name-repo/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/octo-name-repo/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/octocat/octo-name-repo/labels{/name}", "releases_url": "https://api.github.com/repos/octocat/octo-name-repo/releases{/id}", "deployments_url": "https://api.github.com/repos/octocat/octo-name-repo/deployments" }, "html_url": "https://github.com/octocat/octo-name-repo/packages/40201" }, "schema": { "title": "Package", "description": "A software package", "type": "object", "properties": { "id": { "description": "Unique identifier of the package.", "type": "integer", "examples": [ 1 ] }, "name": { "description": "The name of the package.", "type": "string", "examples": [ "super-linter" ] }, "package_type": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ], "examples": [ "docker" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/packages/container/super-linter" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/package/super-linter" ] }, "version_count": { "description": "The number of versions of the package.", "type": "integer", "examples": [ 1 ] }, "visibility": { "type": "string", "enum": [ "private", "public" ], "examples": [ "private" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "repository": { "anyOf": [ { "type": "null" }, { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "package_type", "visibility", "url", "html_url", "version_count", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific package for a package owned by the authenticated user.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/packages/{package_type}/{package_name}", "title": "Delete a package for the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
\nTo use this endpoint, you must authenticate using an access token with the packages:read and packages:delete scopes.\nIf package_type is not container, your token must also include the repo scope.
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/packages/{package_type}/{package_name}/restore", "title": "Restore a package for the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "token", "description": "package token
", "schema": { "type": "string" }, "required": false, "in": "query" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Restores a package owned by the authenticated user.
\nYou can restore a deleted package under the following conditions:
\n- \n
- The package was deleted within the last 30 days. \n
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. \n
To use this endpoint, you must authenticate using an access token with the packages:read and packages:write scopes. If package_type is not container, your token must also include the repo scope.
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/packages/{package_type}/{package_name}/versions", "title": "List package versions for a package owned by the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "state", "in": "query", "required": false, "description": "The state of the package, either active or deleted.
", "schema": { "type": "string", "enum": [ "active", "deleted" ], "default": "active" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 45763, "name": "sha256:08a44bab0bddaddd8837a8b381aebc2e4b933768b981685a9e088360af0d3dd9", "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/45763", "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker", "created_at": "2020-09-11T21:56:40Z", "updated_at": "2021-02-05T21:32:32Z", "html_url": "https://github.com/users/octocat/packages/container/hello_docker/45763", "metadata": { "package_type": "container", "container": { "tags": [ "latest" ] } } }, { "id": 881, "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344", "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/881", "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker", "created_at": "2020-05-21T22:22:20Z", "updated_at": "2021-02-05T21:32:32Z", "html_url": "https://github.com/users/octocat/packages/container/hello_docker/881", "metadata": { "package_type": "container", "container": { "tags": [] } } } ], "schema": { "type": "array", "items": { "title": "Package Version", "description": "A version of a software package", "type": "object", "properties": { "id": { "description": "Unique identifier of the package version.", "type": "integer", "examples": [ 1 ] }, "name": { "description": "The name of the package version.", "type": "string", "examples": [ "latest" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" ] }, "package_html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/package/super-linter" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/super-linter/786068" ] }, "license": { "type": "string", "examples": [ "MIT" ] }, "description": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "deleted_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "metadata": { "type": "object", "title": "Package Version Metadata", "properties": { "package_type": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ], "examples": [ "docker" ] }, "container": { "type": "object", "title": "Container Metadata", "properties": { "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "tags" ] }, "docker": { "type": "object", "title": "Docker Metadata", "properties": { "tag": { "type": "array", "items": { "type": "string" } } }, "required": [ "tags" ] } }, "required": [ "package_type" ] } }, "required": [ "id", "name", "url", "package_html_url", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists package versions for a package owned by the authenticated user.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}", "title": "Get a package version for the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "package_version_id", "description": "Unique identifier of the package version.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 214, "name": "sha256:3561f0cff06caccddb99c93bd26e712fcc56a811de0f8ea7a17bb865f30b176a", "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/214", "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker", "created_at": "2020-05-15T03:46:45Z", "updated_at": "2020-05-15T03:46:45Z", "html_url": "https://github.com/users/octocat/packages/container/hello_docker/214", "metadata": { "package_type": "container", "container": { "tags": [ "1.13.6" ] } } }, "schema": { "title": "Package Version", "description": "A version of a software package", "type": "object", "properties": { "id": { "description": "Unique identifier of the package version.", "type": "integer", "examples": [ 1 ] }, "name": { "description": "The name of the package version.", "type": "string", "examples": [ "latest" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" ] }, "package_html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/package/super-linter" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/super-linter/786068" ] }, "license": { "type": "string", "examples": [ "MIT" ] }, "description": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "deleted_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "metadata": { "type": "object", "title": "Package Version Metadata", "properties": { "package_type": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ], "examples": [ "docker" ] }, "container": { "type": "object", "title": "Container Metadata", "properties": { "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "tags" ] }, "docker": { "type": "object", "title": "Docker Metadata", "properties": { "tag": { "type": "array", "items": { "type": "string" } } }, "required": [ "tags" ] } }, "required": [ "package_type" ] } }, "required": [ "id", "name", "url", "package_html_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific package version for a package owned by the authenticated user.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}", "title": "Delete a package version for the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "package_version_id", "description": "Unique identifier of the package version.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:delete scopes.\nIf package_type is not container, your token must also include the repo scope.
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "title": "Restore a package version for the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "package_version_id", "description": "Unique identifier of the package version.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Restores a package version owned by the authenticated user.
\nYou can restore a deleted package version under the following conditions:
\n- \n
- The package was deleted within the last 30 days. \n
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. \n
To use this endpoint, you must authenticate using an access token with the packages:read and packages:write scopes. If package_type is not container, your token must also include the repo scope.
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/packages", "title": "List packages for a user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The selected visibility of the packages. Only container package_types currently support internal visibility properly. For other ecosystems internal is synonymous with private. This parameter is optional and only filters an existing result set.
The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 197, "name": "hello_docker", "package_type": "container", "owner": { "login": "monalisa", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.monalisausercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "User", "site_admin": false }, "version_count": 1, "visibility": "private", "url": "https://api.github.com/orgs/github/packages/container/hello_docker", "created_at": "2020-05-19T22:19:11Z", "updated_at": "2020-05-19T22:19:11Z", "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" }, { "id": 198, "name": "goodbye_docker", "package_type": "container", "owner": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "User", "site_admin": false }, "version_count": 2, "visibility": "private", "url": "https://api.github.com/user/monalisa/packages/container/goodbye_docker", "created_at": "2020-05-20T22:19:11Z", "updated_at": "2020-05-20T22:19:11Z", "html_url": "https://github.com/user/monalisa/packages/container/package/goodbye_docker" } ], "schema": { "type": "array", "items": { "title": "Package", "description": "A software package", "type": "object", "properties": { "id": { "description": "Unique identifier of the package.", "type": "integer", "examples": [ 1 ] }, "name": { "description": "The name of the package.", "type": "string", "examples": [ "super-linter" ] }, "package_type": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ], "examples": [ "docker" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/packages/container/super-linter" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/package/super-linter" ] }, "version_count": { "description": "The number of versions of the package.", "type": "integer", "examples": [ 1 ] }, "visibility": { "type": "string", "enum": [ "private", "public" ], "examples": [ "private" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "repository": { "anyOf": [ { "type": "null" }, { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "package_type", "visibility", "url", "html_url", "version_count", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists all packages in a user's namespace for which the requesting user has access.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/packages/{package_type}/{package_name}", "title": "Get a package for a user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 40201, "name": "octo-name", "package_type": "rubygems", "owner": { "login": "octocat", "id": 209477, "node_id": "MDQ6VXNlcjIwOTQ3Nw==", "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "version_count": 3, "visibility": "public", "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name", "created_at": "2019-10-20T14:17:14Z", "updated_at": "2019-10-20T14:17:14Z", "repository": { "id": 216219492, "node_id": "MDEwOlJlcG9zaXRvcnkyMTYyMTk0OTI=", "name": "octo-name-repo", "full_name": "octocat/octo-name-repo", "private": false, "owner": { "login": "octocat", "id": 209477, "node_id": "MDQ6VXNlcjIwOTQ3Nw==", "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "html_url": "https://github.com/octocat/octo-name-repo", "description": "Project for octocats", "fork": false, "url": "https://api.github.com/repos/octocat/octo-name-repo", "forks_url": "https://api.github.com/repos/octocat/octo-name-repo/forks", "keys_url": "https://api.github.com/repos/octocat/octo-name-repo/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/octocat/octo-name-repo/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/octocat/octo-name-repo/teams", "hooks_url": "https://api.github.com/repos/octocat/octo-name-repo/hooks", "issue_events_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/events{/number}", "events_url": "https://api.github.com/repos/octocat/octo-name-repo/events", "assignees_url": "https://api.github.com/repos/octocat/octo-name-repo/assignees{/user}", "branches_url": "https://api.github.com/repos/octocat/octo-name-repo/branches{/branch}", "tags_url": "https://api.github.com/repos/octocat/octo-name-repo/tags", "blobs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/octo-name-repo/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/refs{/sha}", "trees_url": "https://api.github.com/repos/octocat/octo-name-repo/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/octocat/octo-name-repo/statuses/{sha}", "languages_url": "https://api.github.com/repos/octocat/octo-name-repo/languages", "stargazers_url": "https://api.github.com/repos/octocat/octo-name-repo/stargazers", "contributors_url": "https://api.github.com/repos/octocat/octo-name-repo/contributors", "subscribers_url": "https://api.github.com/repos/octocat/octo-name-repo/subscribers", "subscription_url": "https://api.github.com/repos/octocat/octo-name-repo/subscription", "commits_url": "https://api.github.com/repos/octocat/octo-name-repo/commits{/sha}", "git_commits_url": "https://api.github.com/repos/octocat/octo-name-repo/git/commits{/sha}", "comments_url": "https://api.github.com/repos/octocat/octo-name-repo/comments{/number}", "issue_comment_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/comments{/number}", "contents_url": "https://api.github.com/repos/octocat/octo-name-repo/contents/{+path}", "compare_url": "https://api.github.com/repos/octocat/octo-name-repo/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/octocat/octo-name-repo/merges", "archive_url": "https://api.github.com/repos/octocat/octo-name-repo/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/octocat/octo-name-repo/downloads", "issues_url": "https://api.github.com/repos/octocat/octo-name-repo/issues{/number}", "pulls_url": "https://api.github.com/repos/octocat/octo-name-repo/pulls{/number}", "milestones_url": "https://api.github.com/repos/octocat/octo-name-repo/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/octo-name-repo/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/octocat/octo-name-repo/labels{/name}", "releases_url": "https://api.github.com/repos/octocat/octo-name-repo/releases{/id}", "deployments_url": "https://api.github.com/repos/octocat/octo-name-repo/deployments" }, "html_url": "https://github.com/octocat/octo-name-repo/packages/40201" }, "schema": { "title": "Package", "description": "A software package", "type": "object", "properties": { "id": { "description": "Unique identifier of the package.", "type": "integer", "examples": [ 1 ] }, "name": { "description": "The name of the package.", "type": "string", "examples": [ "super-linter" ] }, "package_type": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ], "examples": [ "docker" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/packages/container/super-linter" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/package/super-linter" ] }, "version_count": { "description": "The number of versions of the package.", "type": "integer", "examples": [ 1 ] }, "visibility": { "type": "string", "enum": [ "private", "public" ], "examples": [ "private" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "repository": { "anyOf": [ { "type": "null" }, { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "package_type", "visibility", "url", "html_url", "version_count", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific package metadata for a public package owned by a user.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/users/{username}/packages/{package_type}/{package_name}", "title": "Delete a package for a user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
\nTo use this endpoint, you must authenticate using an access token with the packages:read and packages:delete scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container you want to delete. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/users/{username}/packages/{package_type}/{package_name}/restore", "title": "Restore a package for a user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "token", "description": "package token
", "schema": { "type": "string" }, "required": false, "in": "query" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Restores an entire package for a user.
\nYou can restore a deleted package under the following conditions:
\n- \n
- The package was deleted within the last 30 days. \n
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. \n
To use this endpoint, you must authenticate using an access token with the packages:read and packages:write scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container that you want to restore. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions", "title": "List package versions for a package owned by a user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 3497268, "name": "0.3.0", "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/3497268", "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", "license": "MIT", "created_at": "2020-08-31T15:22:11Z", "updated_at": "2020-08-31T15:22:12Z", "description": "Project for octocats", "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.3.0", "metadata": { "package_type": "rubygems" } }, { "id": 387039, "name": "0.2.0", "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039", "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", "license": "MIT", "created_at": "2019-12-01T20:49:29Z", "updated_at": "2019-12-01T20:49:30Z", "description": "Project for octocats", "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0", "metadata": { "package_type": "rubygems" } }, { "id": 169770, "name": "0.1.0", "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/169770", "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", "license": "MIT", "created_at": "2019-10-20T14:17:14Z", "updated_at": "2019-10-20T14:17:15Z", "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.1.0", "metadata": { "package_type": "rubygems" } } ], "schema": { "type": "array", "items": { "title": "Package Version", "description": "A version of a software package", "type": "object", "properties": { "id": { "description": "Unique identifier of the package version.", "type": "integer", "examples": [ 1 ] }, "name": { "description": "The name of the package version.", "type": "string", "examples": [ "latest" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" ] }, "package_html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/package/super-linter" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/super-linter/786068" ] }, "license": { "type": "string", "examples": [ "MIT" ] }, "description": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "deleted_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "metadata": { "type": "object", "title": "Package Version Metadata", "properties": { "package_type": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ], "examples": [ "docker" ] }, "container": { "type": "object", "title": "Container Metadata", "properties": { "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "tags" ] }, "docker": { "type": "object", "title": "Docker Metadata", "properties": { "tag": { "type": "array", "items": { "type": "string" } } }, "required": [ "tags" ] } }, "required": [ "package_type" ] } }, "required": [ "id", "name", "url", "package_html_url", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists package versions for a public package owned by a specified user.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", "title": "Get a package version for a user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "package_version_id", "description": "Unique identifier of the package version.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "package_version_id": "PACKAGE_VERSION_ID", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 387039, "name": "0.2.0", "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039", "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", "license": "MIT", "created_at": "2019-12-01T20:49:29Z", "updated_at": "2019-12-01T20:49:30Z", "description": "Octo-name client for Ruby", "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0", "metadata": { "package_type": "rubygems" } }, "schema": { "title": "Package Version", "description": "A version of a software package", "type": "object", "properties": { "id": { "description": "Unique identifier of the package version.", "type": "integer", "examples": [ 1 ] }, "name": { "description": "The name of the package version.", "type": "string", "examples": [ "latest" ] }, "url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" ] }, "package_html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/package/super-linter" ] }, "html_url": { "type": "string", "examples": [ "https://github.com/orgs/github/packages/container/super-linter/786068" ] }, "license": { "type": "string", "examples": [ "MIT" ] }, "description": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "deleted_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "metadata": { "type": "object", "title": "Package Version Metadata", "properties": { "package_type": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ], "examples": [ "docker" ] }, "container": { "type": "object", "title": "Container Metadata", "properties": { "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "tags" ] }, "docker": { "type": "object", "title": "Docker Metadata", "properties": { "tag": { "type": "array", "items": { "type": "string" } } }, "required": [ "tags" ] } }, "required": [ "package_type" ] } }, "required": [ "id", "name", "url", "package_html_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Gets a specific package version for a public package owned by a specified user.
\nAt this time, to use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", "title": "Delete package version for a user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "package_version_id", "description": "Unique identifier of the package version.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "username": "USERNAME", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
\nTo use this endpoint, you must authenticate using an access token with the packages:read and packages:delete scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container you want to delete. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "title": "Restore package version for a user", "category": "packages", "parameters": [ { "name": "package_type", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "package_version_id", "description": "Unique identifier of the package version.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "username": "USERNAME", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Restores a specific package version for a user.
\nYou can restore a deleted package under the following conditions:
\n- \n
- The package was deleted within the last 30 days. \n
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. \n
To use this endpoint, you must authenticate using an access token with the packages:read and packages:write scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container that you want to restore. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" } ] }, "pages": { "pages": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages", "title": "Get a GitHub Pages site", "category": "pages", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", "cname": "developer.github.com", "custom_404": false, "html_url": "https://developer.github.com", "source": { "branch": "master", "path": "/" }, "public": true, "https_certificate": { "state": "approved", "description": "Certificate is approved", "domains": [ "developer.github.com" ], "expires_at": "2021-05-22" }, "https_enforced": true }, "schema": { "title": "GitHub Pages", "description": "The configuration for GitHub Pages for a repository.", "type": "object", "properties": { "url": { "type": "string", "description": "The API address for accessing this Page resource.", "format": "uri", "examples": [ "https://api.github.com/repos/github/hello-world/pages" ] }, "status": { "type": [ "string", "null" ], "description": "The status of the most recent build of the Page.", "enum": [ "built", "building", "errored", null ], "examples": [ "built" ] }, "cname": { "description": "The Pages site's custom domain", "type": [ "string", "null" ], "examples": [ "example.com" ] }, "protected_domain_state": { "type": [ "string", "null" ], "description": "The state if the domain is verified", "enum": [ "pending", "verified", "unverified", null ], "examples": [ "pending" ] }, "pending_domain_unverified_at": { "type": [ "string", "null" ], "description": "The timestamp when a pending domain becomes unverified.", "format": "date-time" }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", "default": false, "examples": [ false ] }, "html_url": { "type": "string", "description": "The web address the Page can be accessed from.", "format": "uri", "examples": [ "https://example.com" ] }, "build_type": { "type": [ "string", "null" ], "description": "The process in which the Page will be built.", "enum": [ "legacy", "workflow", null ], "examples": [ "legacy" ] }, "source": { "title": "Pages Source Hash", "type": "object", "properties": { "branch": { "type": "string" }, "path": { "type": "string" } }, "required": [ "branch", "path" ] }, "public": { "type": "boolean", "description": "Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site.", "examples": [ true ] }, "https_certificate": { "title": "Pages Https Certificate", "type": "object", "properties": { "state": { "type": "string", "enum": [ "new", "authorization_created", "authorization_pending", "authorized", "authorization_revoked", "issued", "uploaded", "approved", "errored", "bad_authz", "destroy_pending", "dns_changed" ], "examples": [ "approved" ] }, "description": { "type": "string", "examples": [ "Certificate is approved" ] }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Array of the domain set and its alternate name (if it is configured)", "examples": [ "example.com", "www.example.com" ] }, "expires_at": { "type": "string", "format": "date" } }, "required": [ "state", "description", "domains" ] }, "https_enforced": { "type": "boolean", "description": "Whether https is enabled on the domain", "examples": [ true ] } }, "required": [ "url", "status", "cname", "custom_404", "public" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages", "title": "Create a GitHub Pages site", "category": "pages", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "build_type", "in": "body", "description": "The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".
The source branch and directory used to publish your Pages site.
", "childParamsGroups": [ { "type": "string", "name": "branch", "description": "The repository branch used to publish your site's source files.
", "isRequired": true }, { "type": "string", "name": "path", "description": "The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /
Response
", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", "cname": "developer.github.com", "custom_404": false, "html_url": "https://developer.github.com", "source": { "branch": "master", "path": "/" }, "public": true, "https_certificate": { "state": "approved", "description": "Certificate is approved", "domains": [ "developer.github.com" ], "expires_at": "2021-05-22" }, "https_enforced": true }, "schema": { "title": "GitHub Pages", "description": "The configuration for GitHub Pages for a repository.", "type": "object", "properties": { "url": { "type": "string", "description": "The API address for accessing this Page resource.", "format": "uri", "examples": [ "https://api.github.com/repos/github/hello-world/pages" ] }, "status": { "type": [ "string", "null" ], "description": "The status of the most recent build of the Page.", "enum": [ "built", "building", "errored", null ], "examples": [ "built" ] }, "cname": { "description": "The Pages site's custom domain", "type": [ "string", "null" ], "examples": [ "example.com" ] }, "protected_domain_state": { "type": [ "string", "null" ], "description": "The state if the domain is verified", "enum": [ "pending", "verified", "unverified", null ], "examples": [ "pending" ] }, "pending_domain_unverified_at": { "type": [ "string", "null" ], "description": "The timestamp when a pending domain becomes unverified.", "format": "date-time" }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", "default": false, "examples": [ false ] }, "html_url": { "type": "string", "description": "The web address the Page can be accessed from.", "format": "uri", "examples": [ "https://example.com" ] }, "build_type": { "type": [ "string", "null" ], "description": "The process in which the Page will be built.", "enum": [ "legacy", "workflow", null ], "examples": [ "legacy" ] }, "source": { "title": "Pages Source Hash", "type": "object", "properties": { "branch": { "type": "string" }, "path": { "type": "string" } }, "required": [ "branch", "path" ] }, "public": { "type": "boolean", "description": "Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site.", "examples": [ true ] }, "https_certificate": { "title": "Pages Https Certificate", "type": "object", "properties": { "state": { "type": "string", "enum": [ "new", "authorization_created", "authorization_pending", "authorized", "authorization_revoked", "issued", "uploaded", "approved", "errored", "bad_authz", "destroy_pending", "dns_changed" ], "examples": [ "approved" ] }, "description": { "type": "string", "examples": [ "Certificate is approved" ] }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Array of the domain set and its alternate name (if it is configured)", "examples": [ "example.com", "www.example.com" ] }, "expires_at": { "type": "string", "format": "date" } }, "required": [ "state", "description", "domains" ] }, "https_enforced": { "type": "boolean", "description": "Whether https is enabled on the domain", "examples": [ true ] } }, "required": [ "url", "status", "cname", "custom_404", "public" ] } } } ], "previews": [], "descriptionHTML": "Configures a GitHub Pages site. For more information, see \"About GitHub Pages.\"
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/pages", "title": "Update information about a GitHub Pages site", "category": "pages", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string or null", "name": "cname", "in": "body", "description": "Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"
Specify whether HTTPS should be enforced for the repository.
" }, { "type": "boolean", "name": "public", "in": "body", "description": "Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.
The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.
Response
" } } ], "previews": [], "descriptionHTML": "Updates information for a GitHub Pages site. For more information, see \"About GitHub Pages.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pages", "title": "Delete a GitHub Pages site", "category": "pages", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds", "title": "List GitHub Pages builds", "category": "pages", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", "error": { "message": null }, "pusher": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b", "duration": 2104, "created_at": "2014-02-10T19:00:49Z", "updated_at": "2014-02-10T19:00:51Z" } ], "schema": { "type": "array", "items": { "title": "Page Build", "description": "Page Build", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "status": { "type": "string" }, "error": { "type": "object", "properties": { "message": { "type": [ "string", "null" ] } }, "required": [ "message" ] }, "pusher": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "commit": { "type": "string" }, "duration": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "url", "status", "error", "pusher", "commit", "duration", "created_at", "updated_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages/builds", "title": "Request a GitHub Pages build", "category": "pages", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/latest", "status": "queued" }, "schema": { "title": "Page Build Status", "description": "Page Build Status", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/github/hello-world/pages/builds/latest" ] }, "status": { "type": "string", "examples": [ "queued" ] } }, "required": [ "url", "status" ] } } } ], "previews": [], "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/latest", "title": "Get latest Pages build", "category": "pages", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", "error": { "message": null }, "pusher": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b", "duration": 2104, "created_at": "2014-02-10T19:00:49Z", "updated_at": "2014-02-10T19:00:51Z" }, "schema": { "title": "Page Build", "description": "Page Build", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "status": { "type": "string" }, "error": { "type": "object", "properties": { "message": { "type": [ "string", "null" ] } }, "required": [ "message" ] }, "pusher": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "commit": { "type": "string" }, "duration": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "url", "status", "error", "pusher", "commit", "duration", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}", "title": "Get GitHub Pages build", "category": "pages", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "build_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "build_id": "BUILD_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", "error": { "message": null }, "pusher": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b", "duration": 2104, "created_at": "2014-02-10T19:00:49Z", "updated_at": "2014-02-10T19:00:51Z" }, "schema": { "title": "Page Build", "description": "Page Build", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "status": { "type": "string" }, "error": { "type": "object", "properties": { "message": { "type": [ "string", "null" ] } }, "required": [ "message" ] }, "pusher": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "commit": { "type": "string" }, "duration": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "url", "status", "error", "pusher", "commit", "duration", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages/deployment", "title": "Create a GitHub Pages deployment", "category": "pages", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "artifact_url", "in": "body", "description": "The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository.
", "isRequired": true }, { "type": "string", "name": "environment", "in": "body", "description": "The target environment for this GitHub Pages deployment.
", "default": "github-pages" }, { "type": "string", "name": "pages_build_version", "in": "body", "description": "A unique string that represents the version of the build for this deployment.
", "isRequired": true, "default": "GITHUB_SHA" }, { "type": "string", "name": "oidc_token", "in": "body", "description": "The OIDC token issued by GitHub Actions certifying the origin of the deployment.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "artifact_url": "https://downloadcontent/", "environment": "github-pages", "pages_build_version": "4fd754f7e594640989b406850d0bc8f06a121251", "oidc_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA", "preview": false }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status", "page_url": "developer.github.com" }, "schema": { "title": "GitHub Pages", "description": "The GitHub Pages deployment status.", "type": "object", "properties": { "status_url": { "type": "string", "description": "The URI to monitor GitHub Pages deployment status.", "format": "uri", "examples": [ "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status" ] }, "page_url": { "type": "string", "description": "The URI to the deployed GitHub Pages.", "format": "uri", "examples": [ "hello-world.github.io" ] }, "preview_url": { "type": "string", "description": "The URI to the deployed GitHub Pages preview.", "format": "uri", "examples": [ "monalisa-1231a2312sa32-23sda74.drafts.github.io" ] } }, "required": [ "status_url", "page_url" ] } } } ], "previews": [], "descriptionHTML": "Create a GitHub Pages deployment for a repository.
\nUsers must have write permissions. GitHub Apps must have the pages:write permission to use this endpoint.
OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/health", "title": "Get a DNS health check for GitHub Pages", "category": "pages", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "domain": { "host": "example.com", "uri": "http://example.com/", "nameservers": "default", "dns_resolves": true, "is_proxied": false, "is_cloudflare_ip": false, "is_fastly_ip": false, "is_old_ip_address": false, "is_a_record": true, "has_cname_record": false, "has_mx_records_present": false, "is_valid_domain": true, "is_apex_domain": true, "should_be_a_record": true, "is_cname_to_github_user_domain": false, "is_cname_to_pages_dot_github_dot_com": false, "is_cname_to_fastly": false, "is_pointed_to_github_pages_ip": true, "is_non_github_pages_ip_present": false, "is_pages_domain": false, "is_served_by_pages": true, "is_valid": true, "reason": null, "responds_to_https": true, "enforces_https": true, "https_error": null, "is_https_eligible": true, "caa_error": null }, "alt_domain": { "host": "www.example.com", "uri": "http://www.example.com/", "nameservers": "default", "dns_resolves": true, "is_proxied": false, "is_cloudflare_ip": false, "is_fastly_ip": false, "is_old_ip_address": false, "is_a_record": true, "has_cname_record": false, "has_mx_records_present": false, "is_valid_domain": true, "is_apex_domain": true, "should_be_a_record": true, "is_cname_to_github_user_domain": false, "is_cname_to_pages_dot_github_dot_com": false, "is_cname_to_fastly": false, "is_pointed_to_github_pages_ip": true, "is_non_github_pages_ip_present": false, "is_pages_domain": false, "is_served_by_pages": true, "is_valid": true, "reason": null, "responds_to_https": true, "enforces_https": true, "https_error": null, "is_https_eligible": true, "caa_error": null } }, "schema": { "title": "Pages Health Check Status", "description": "Pages Health Check Status", "type": "object", "properties": { "domain": { "type": "object", "properties": { "host": { "type": "string" }, "uri": { "type": "string" }, "nameservers": { "type": "string" }, "dns_resolves": { "type": "boolean" }, "is_proxied": { "type": [ "boolean", "null" ] }, "is_cloudflare_ip": { "type": [ "boolean", "null" ] }, "is_fastly_ip": { "type": [ "boolean", "null" ] }, "is_old_ip_address": { "type": [ "boolean", "null" ] }, "is_a_record": { "type": [ "boolean", "null" ] }, "has_cname_record": { "type": [ "boolean", "null" ] }, "has_mx_records_present": { "type": [ "boolean", "null" ] }, "is_valid_domain": { "type": "boolean" }, "is_apex_domain": { "type": "boolean" }, "should_be_a_record": { "type": [ "boolean", "null" ] }, "is_cname_to_github_user_domain": { "type": [ "boolean", "null" ] }, "is_cname_to_pages_dot_github_dot_com": { "type": [ "boolean", "null" ] }, "is_cname_to_fastly": { "type": [ "boolean", "null" ] }, "is_pointed_to_github_pages_ip": { "type": [ "boolean", "null" ] }, "is_non_github_pages_ip_present": { "type": [ "boolean", "null" ] }, "is_pages_domain": { "type": "boolean" }, "is_served_by_pages": { "type": [ "boolean", "null" ] }, "is_valid": { "type": "boolean" }, "reason": { "type": [ "string", "null" ] }, "responds_to_https": { "type": "boolean" }, "enforces_https": { "type": "boolean" }, "https_error": { "type": [ "string", "null" ] }, "is_https_eligible": { "type": [ "boolean", "null" ] }, "caa_error": { "type": [ "string", "null" ] } } }, "alt_domain": { "type": [ "object", "null" ], "properties": { "host": { "type": "string" }, "uri": { "type": "string" }, "nameservers": { "type": "string" }, "dns_resolves": { "type": "boolean" }, "is_proxied": { "type": [ "boolean", "null" ] }, "is_cloudflare_ip": { "type": [ "boolean", "null" ] }, "is_fastly_ip": { "type": [ "boolean", "null" ] }, "is_old_ip_address": { "type": [ "boolean", "null" ] }, "is_a_record": { "type": [ "boolean", "null" ] }, "has_cname_record": { "type": [ "boolean", "null" ] }, "has_mx_records_present": { "type": [ "boolean", "null" ] }, "is_valid_domain": { "type": "boolean" }, "is_apex_domain": { "type": "boolean" }, "should_be_a_record": { "type": [ "boolean", "null" ] }, "is_cname_to_github_user_domain": { "type": [ "boolean", "null" ] }, "is_cname_to_pages_dot_github_dot_com": { "type": [ "boolean", "null" ] }, "is_cname_to_fastly": { "type": [ "boolean", "null" ] }, "is_pointed_to_github_pages_ip": { "type": [ "boolean", "null" ] }, "is_non_github_pages_ip_present": { "type": [ "boolean", "null" ] }, "is_pages_domain": { "type": "boolean" }, "is_served_by_pages": { "type": [ "boolean", "null" ] }, "is_valid": { "type": "boolean" }, "reason": { "type": [ "string", "null" ] }, "responds_to_https": { "type": "boolean" }, "enforces_https": { "type": "boolean" }, "https_error": { "type": [ "string", "null" ] }, "is_https_eligible": { "type": [ "boolean", "null" ] }, "caa_error": { "type": [ "string", "null" ] } } } } } } } ], "previews": [], "descriptionHTML": "Gets a health check of the DNS settings for the CNAME record configured for a repository's GitHub Pages.
The first request to this endpoint returns a 202 Accepted status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a 200 OK status with the health check results in the response.
Users must have admin or owner permissions. GitHub Apps must have the pages:write and administration:write permission to use this endpoint.
OK
" }, { "httpStatusCode": "202", "description": "Empty response
" }, { "httpStatusCode": "400", "description": "Custom domains are not available for GitHub Pages
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "There isn't a CNAME for this page
" } ], "subcategory": "pages" } ] }, "projects": { "projects": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/projects", "title": "List organization projects", "category": "projects", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "description": "Indicates the state of the projects to return. Can be either open, closed, or all.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z" } ], "schema": { "type": "array", "items": { "title": "Project", "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { "owner_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/api-playground/projects-test" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/api-playground/projects-test/projects/12" ] }, "columns_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604/columns" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, "name": { "description": "Name of the project", "type": "string", "examples": [ "Week One Sprint" ] }, "body": { "description": "Body of the project", "type": [ "string", "null" ], "examples": [ "This project represents the sprint of the first week in January" ] }, "number": { "type": "integer", "examples": [ 1 ] }, "state": { "description": "State of the project; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "organization_permission": { "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", "enum": [ "read", "write", "admin", "none" ] }, "private": { "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", "type": "boolean" } }, "required": [ "id", "node_id", "number", "name", "body", "state", "url", "html_url", "owner_url", "creator", "columns_url", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/projects", "title": "Create an organization project", "category": "projects", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name of the project.
", "isRequired": true }, { "type": "string", "name": "body", "in": "body", "description": "The description of the project.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year." }, "parameters": { "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z" }, "schema": { "title": "Project", "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { "owner_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/api-playground/projects-test" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/api-playground/projects-test/projects/12" ] }, "columns_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604/columns" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, "name": { "description": "Name of the project", "type": "string", "examples": [ "Week One Sprint" ] }, "body": { "description": "Body of the project", "type": [ "string", "null" ], "examples": [ "This project represents the sprint of the first week in January" ] }, "number": { "type": "integer", "examples": [ 1 ] }, "state": { "description": "State of the project; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "organization_permission": { "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", "enum": [ "read", "write", "admin", "none" ] }, "private": { "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", "type": "boolean" } }, "required": [ "id", "node_id", "number", "name", "body", "state", "url", "html_url", "owner_url", "creator", "columns_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Creates an organization project board. Returns a 410 Gone status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Created
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/{project_id}", "title": "Get a project", "category": "projects", "parameters": [ { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", "html_url": "https://github.com/api-playground/projects-test/projects/1", "columns_url": "https://api.github.com/projects/1002604/columns", "id": 1002604, "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", "name": "Projects Documentation", "body": "Developer documentation project for the developer site.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" }, "schema": { "title": "Project", "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { "owner_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/api-playground/projects-test" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/api-playground/projects-test/projects/12" ] }, "columns_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604/columns" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, "name": { "description": "Name of the project", "type": "string", "examples": [ "Week One Sprint" ] }, "body": { "description": "Body of the project", "type": [ "string", "null" ], "examples": [ "This project represents the sprint of the first week in January" ] }, "number": { "type": "integer", "examples": [ 1 ] }, "state": { "description": "State of the project; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "organization_permission": { "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", "enum": [ "read", "write", "admin", "none" ] }, "private": { "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", "type": "boolean" } }, "required": [ "id", "node_id", "number", "name", "body", "state", "url", "html_url", "owner_url", "creator", "columns_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/projects/{project_id}", "title": "Update a project", "category": "projects", "parameters": [ { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "Name of the project
" }, { "type": "string or null", "name": "body", "in": "body", "description": "Body of the project
" }, { "type": "string", "name": "state", "in": "body", "description": "State of the project; either 'open' or 'closed'
" }, { "type": "string", "name": "organization_permission", "in": "body", "description": "The baseline permission that all organization members have on this project
", "enum": [ "read", "write", "admin", "none" ] }, { "type": "boolean", "name": "private", "in": "body", "description": "Whether or not this project can be seen by everyone.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Change the name, state, and permissions for a project", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Week One Sprint", "state": "open", "organization_permission": "write" }, "parameters": { "project_id": "PROJECT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", "html_url": "https://github.com/api-playground/projects-test/projects/1", "columns_url": "https://api.github.com/projects/1002604/columns", "id": 1002604, "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", "name": "Projects Documentation", "body": "Developer documentation project for the developer site.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" }, "schema": { "title": "Project", "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { "owner_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/api-playground/projects-test" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/api-playground/projects-test/projects/12" ] }, "columns_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604/columns" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, "name": { "description": "Name of the project", "type": "string", "examples": [ "Week One Sprint" ] }, "body": { "description": "Body of the project", "type": [ "string", "null" ], "examples": [ "This project represents the sprint of the first week in January" ] }, "number": { "type": "integer", "examples": [ 1 ] }, "state": { "description": "State of the project; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "organization_permission": { "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", "enum": [ "read", "write", "admin", "none" ] }, "private": { "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", "type": "boolean" } }, "required": [ "id", "node_id", "number", "name", "body", "state", "url", "html_url", "owner_url", "creator", "columns_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Not Found if the authenticated user does not have access to the project
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/projects/{project_id}", "title": "Delete a project", "category": "projects", "parameters": [ { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" } }, "response": { "statusCode": "204", "description": "Delete Success
" } } ], "previews": [], "descriptionHTML": "Deletes a project board. Returns a 404 Not Found status if projects are disabled.
Delete Success
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/projects", "title": "List repository projects", "category": "projects", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "description": "Indicates the state of the projects to return. Can be either open, closed, or all.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", "html_url": "https://github.com/api-playground/projects-test/projects/1", "columns_url": "https://api.github.com/projects/1002604/columns", "id": 1002604, "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", "name": "Projects Documentation", "body": "Developer documentation project for the developer site.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" } ], "schema": { "type": "array", "items": { "title": "Project", "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { "owner_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/api-playground/projects-test" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/api-playground/projects-test/projects/12" ] }, "columns_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604/columns" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, "name": { "description": "Name of the project", "type": "string", "examples": [ "Week One Sprint" ] }, "body": { "description": "Body of the project", "type": [ "string", "null" ], "examples": [ "This project represents the sprint of the first week in January" ] }, "number": { "type": "integer", "examples": [ 1 ] }, "state": { "description": "State of the project; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "organization_permission": { "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", "enum": [ "read", "write", "admin", "none" ] }, "private": { "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", "type": "boolean" } }, "required": [ "id", "node_id", "number", "name", "body", "state", "url", "html_url", "owner_url", "creator", "columns_url", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/projects", "title": "Create a repository project", "category": "projects", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name of the project.
", "isRequired": true }, { "type": "string", "name": "body", "in": "body", "description": "The description of the project.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Projects Documentation", "body": "Developer documentation project for the developer site." }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", "html_url": "https://github.com/api-playground/projects-test/projects/1", "columns_url": "https://api.github.com/projects/1002604/columns", "id": 1002604, "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", "name": "Projects Documentation", "body": "Developer documentation project for the developer site.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" }, "schema": { "title": "Project", "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { "owner_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/api-playground/projects-test" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/api-playground/projects-test/projects/12" ] }, "columns_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604/columns" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, "name": { "description": "Name of the project", "type": "string", "examples": [ "Week One Sprint" ] }, "body": { "description": "Body of the project", "type": [ "string", "null" ], "examples": [ "This project represents the sprint of the first week in January" ] }, "number": { "type": "integer", "examples": [ 1 ] }, "state": { "description": "State of the project; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "organization_permission": { "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", "enum": [ "read", "write", "admin", "none" ] }, "private": { "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", "type": "boolean" } }, "required": [ "id", "node_id", "number", "name", "body", "state", "url", "html_url", "owner_url", "creator", "columns_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Creates a repository project board. Returns a 410 Gone status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Created
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/projects", "title": "Create a user project", "category": "projects", "parameters": [], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "Name of the project
", "isRequired": true }, { "type": "string or null", "name": "body", "in": "body", "description": "Body of the project
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Create a new project", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "My Projects", "body": "A board to manage my personal projects." } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/users/octocat", "url": "https://api.github.com/projects/1002603", "html_url": "https://github.com/users/octocat/projects/1", "columns_url": "https://api.github.com/projects/1002603/columns", "id": 1002603, "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", "name": "My Projects", "body": "A board to manage my personal projects.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" }, "schema": { "title": "Project", "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { "owner_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/api-playground/projects-test" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/api-playground/projects-test/projects/12" ] }, "columns_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604/columns" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, "name": { "description": "Name of the project", "type": "string", "examples": [ "Week One Sprint" ] }, "body": { "description": "Body of the project", "type": [ "string", "null" ], "examples": [ "This project represents the sprint of the first week in January" ] }, "number": { "type": "integer", "examples": [ 1 ] }, "state": { "description": "State of the project; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "organization_permission": { "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", "enum": [ "read", "write", "admin", "none" ] }, "private": { "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", "type": "boolean" } }, "required": [ "id", "node_id", "number", "name", "body", "state", "url", "html_url", "owner_url", "creator", "columns_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Creates a user project board. Returns a 410 Gone status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/projects", "title": "List user projects", "category": "projects", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "description": "Indicates the state of the projects to return. Can be either open, closed, or all.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "owner_url": "https://api.github.com/users/octocat", "url": "https://api.github.com/projects/1002603", "html_url": "https://github.com/users/octocat/projects/1", "columns_url": "https://api.github.com/projects/1002603/columns", "id": 1002603, "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", "name": "My Projects", "body": "A board to manage my personal projects.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" } ], "schema": { "type": "array", "items": { "title": "Project", "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { "owner_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/api-playground/projects-test" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/api-playground/projects-test/projects/12" ] }, "columns_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/1002604/columns" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, "name": { "description": "Name of the project", "type": "string", "examples": [ "Week One Sprint" ] }, "body": { "description": "Body of the project", "type": [ "string", "null" ], "examples": [ "This project represents the sprint of the first week in January" ] }, "number": { "type": "integer", "examples": [ 1 ] }, "state": { "description": "State of the project; either 'open' or 'closed'", "type": "string", "examples": [ "open" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "organization_permission": { "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", "enum": [ "read", "write", "admin", "none" ] }, "private": { "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", "type": "boolean" } }, "required": [ "id", "node_id", "number", "name", "body", "state", "url", "html_url", "owner_url", "creator", "columns_url", "created_at", "updated_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" } ], "cards": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/columns/cards/{card_id}", "title": "Get a project card", "category": "projects", "subcategory": "cards", "parameters": [ { "name": "card_id", "description": "The unique identifier of the card.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "Add payload for delete Project column", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" }, "schema": { "title": "Project Card", "description": "Project cards represent a scope of work.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/cards/1478" ] }, "id": { "description": "The project card's ID", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, "note": { "type": [ "string", "null" ], "examples": [ "Add payload for delete Project column" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:20:22Z" ] }, "archived": { "description": "Whether or not the card is archived", "type": "boolean", "examples": [ false ] }, "column_name": { "type": "string" }, "project_id": { "type": "string" }, "column_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/367" ] }, "content_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/api-playground/projects-test/issues/3" ] }, "project_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/120" ] } }, "required": [ "id", "node_id", "note", "url", "column_url", "project_url", "creator", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/projects/columns/cards/{card_id}", "title": "Update an existing project card", "category": "projects", "subcategory": "cards", "parameters": [ { "name": "card_id", "description": "The unique identifier of the card.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string or null", "name": "note", "in": "body", "description": "The project card's note
" }, { "type": "boolean", "name": "archived", "in": "body", "description": "Whether or not the card is archived
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Change the note on the card", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "note": "Add payload for delete Project column" }, "parameters": { "card_id": "CARD_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "Add payload for delete Project column", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" }, "schema": { "title": "Project Card", "description": "Project cards represent a scope of work.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/cards/1478" ] }, "id": { "description": "The project card's ID", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, "note": { "type": [ "string", "null" ], "examples": [ "Add payload for delete Project column" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:20:22Z" ] }, "archived": { "description": "Whether or not the card is archived", "type": "boolean", "examples": [ false ] }, "column_name": { "type": "string" }, "project_id": { "type": "string" }, "column_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/367" ] }, "content_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/api-playground/projects-test/issues/3" ] }, "project_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/120" ] } }, "required": [ "id", "node_id", "note", "url", "column_url", "project_url", "creator", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/projects/columns/cards/{card_id}", "title": "Delete a project card", "category": "projects", "subcategory": "cards", "parameters": [ { "name": "card_id", "description": "The unique identifier of the card.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/projects/columns/cards/{card_id}/moves", "title": "Move a project card", "category": "projects", "subcategory": "cards", "parameters": [ { "name": "card_id", "description": "The unique identifier of the card.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "position", "in": "body", "description": "The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.
The unique identifier of the column the card should be moved to
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Move the card to the bottom of the column", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "column_id": 42, "position": "bottom" }, "parameters": { "card_id": "CARD_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": null, "schema": { "type": "object", "properties": {}, "additionalProperties": false } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service Unavailable
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/columns/{column_id}/cards", "title": "List project cards", "category": "projects", "subcategory": "cards", "parameters": [ { "name": "column_id", "description": "The unique identifier of the column.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "archived_state", "description": "Filters the project cards that are returned by the card's state.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "archived", "not_archived" ], "default": "not_archived" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "Add payload for delete Project column", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" } ], "schema": { "type": "array", "items": { "title": "Project Card", "description": "Project cards represent a scope of work.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/cards/1478" ] }, "id": { "description": "The project card's ID", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, "note": { "type": [ "string", "null" ], "examples": [ "Add payload for delete Project column" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:20:22Z" ] }, "archived": { "description": "Whether or not the card is archived", "type": "boolean", "examples": [ false ] }, "column_name": { "type": "string" }, "project_id": { "type": "string" }, "column_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/367" ] }, "content_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/api-playground/projects-test/issues/3" ] }, "project_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/120" ] } }, "required": [ "id", "node_id", "note", "url", "column_url", "project_url", "creator", "created_at", "updated_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/projects/columns/{column_id}/cards", "title": "Create a project card", "category": "projects", "subcategory": "cards", "parameters": [ { "name": "column_id", "description": "The unique identifier of the column.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string or null", "name": "note", "in": "body", "description": "The project card's note
", "isRequired": true }, { "type": "integer", "name": "content_id", "in": "body", "description": "The unique identifier of the content associated with the card
", "isRequired": true }, { "type": "string", "name": "content_type", "in": "body", "description": "The piece of content associated with the card
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Create a new card", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "note": "Add payload for delete Project column" }, "parameters": { "column_id": "COLUMN_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "Add payload for delete Project column", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" }, "schema": { "title": "Project Card", "description": "Project cards represent a scope of work.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/cards/1478" ] }, "id": { "description": "The project card's ID", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, "note": { "type": [ "string", "null" ], "examples": [ "Add payload for delete Project column" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:20:22Z" ] }, "archived": { "description": "Whether or not the card is archived", "type": "boolean", "examples": [ false ] }, "column_name": { "type": "string" }, "project_id": { "type": "string" }, "column_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/367" ] }, "content_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/api-playground/projects-test/issues/3" ] }, "project_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/120" ] } }, "required": [ "id", "node_id", "note", "url", "column_url", "project_url", "creator", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service Unavailable
" } ] } ], "collaborators": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/{project_id}/collaborators", "title": "List project collaborators", "category": "projects", "subcategory": "collaborators", "parameters": [ { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "affiliation", "description": "Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/projects/{project_id}/collaborators/{username}", "title": "Add project collaborator", "category": "projects", "subcategory": "collaborators", "parameters": [ { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "permission", "in": "body", "description": "The permission to grant the collaborator.
", "enum": [ "read", "write", "admin" ], "default": "write" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "contentType": "application/json", "description": "Applying write permissions for the new collaborator", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "permission": "write" }, "parameters": { "project_id": "PROJECT_ID", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/projects/{project_id}/collaborators/{username}", "title": "Remove user as a collaborator", "category": "projects", "subcategory": "collaborators", "parameters": [ { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/{project_id}/collaborators/{username}/permission", "title": "Get project permission for a user", "category": "projects", "subcategory": "collaborators", "parameters": [ { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "permission": "admin", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, "schema": { "title": "Project Collaborator Permission", "description": "Project Collaborator Permission", "type": "object", "properties": { "permission": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "permission", "user" ] } } } ], "previews": [], "descriptionHTML": "Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "columns": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/columns/{column_id}", "title": "Get a project column", "category": "projects", "subcategory": "columns", "parameters": [ { "name": "column_id", "description": "The unique identifier of the column.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" }, "schema": { "title": "Project Column", "description": "Project columns contain cards of work.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/367" ] }, "project_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/120" ] }, "cards_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/367/cards" ] }, "id": { "description": "The unique identifier of the project column", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEzOlByb2plY3RDb2x1bW4zNjc=" ] }, "name": { "description": "Name of the project column", "type": "string", "examples": [ "Remaining tasks" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:18:44Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:22:28Z" ] } }, "required": [ "id", "node_id", "url", "project_url", "cards_url", "name", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/projects/columns/{column_id}", "title": "Update an existing project column", "category": "projects", "subcategory": "columns", "parameters": [ { "name": "column_id", "description": "The unique identifier of the column.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "Name of the project column
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Rename the project column", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "To Do" }, "parameters": { "column_id": "COLUMN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" }, "schema": { "title": "Project Column", "description": "Project columns contain cards of work.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/367" ] }, "project_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/120" ] }, "cards_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/367/cards" ] }, "id": { "description": "The unique identifier of the project column", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEzOlByb2plY3RDb2x1bW4zNjc=" ] }, "name": { "description": "Name of the project column", "type": "string", "examples": [ "Remaining tasks" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:18:44Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:22:28Z" ] } }, "required": [ "id", "node_id", "url", "project_url", "cards_url", "name", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/projects/columns/{column_id}", "title": "Delete a project column", "category": "projects", "subcategory": "columns", "parameters": [ { "name": "column_id", "description": "The unique identifier of the column.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/projects/columns/{column_id}/moves", "title": "Move a project column", "category": "projects", "subcategory": "columns", "parameters": [ { "name": "column_id", "description": "The unique identifier of the column.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "position", "in": "body", "description": "The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.
Response
", "example": null, "schema": { "type": "object", "properties": {}, "additionalProperties": false } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/{project_id}/columns", "title": "List project columns", "category": "projects", "subcategory": "columns", "parameters": [ { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" } ], "schema": { "type": "array", "items": { "title": "Project Column", "description": "Project columns contain cards of work.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/367" ] }, "project_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/120" ] }, "cards_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/367/cards" ] }, "id": { "description": "The unique identifier of the project column", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEzOlByb2plY3RDb2x1bW4zNjc=" ] }, "name": { "description": "Name of the project column", "type": "string", "examples": [ "Remaining tasks" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:18:44Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:22:28Z" ] } }, "required": [ "id", "node_id", "url", "project_url", "cards_url", "name", "created_at", "updated_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/projects/{project_id}/columns", "title": "Create a project column", "category": "projects", "subcategory": "columns", "parameters": [ { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "Name of the project column
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Remaining tasks" }, "parameters": { "project_id": "PROJECT_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" }, "schema": { "title": "Project Column", "description": "Project columns contain cards of work.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/367" ] }, "project_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/120" ] }, "cards_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/projects/columns/367/cards" ] }, "id": { "description": "The unique identifier of the project column", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEzOlByb2plY3RDb2x1bW4zNjc=" ] }, "name": { "description": "Name of the project column", "type": "string", "examples": [ "Remaining tasks" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:18:44Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2016-09-05T14:22:28Z" ] } }, "required": [ "id", "node_id", "url", "project_url", "cards_url", "name", "created_at", "updated_at" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ] }, "pulls": { "pulls": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls", "title": "List pull requests", "category": "pulls", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "description": "Either open, closed, or all to filter by state.
Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.
Filter pulls by base branch name. Example: gh-pages.
What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month).
The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "number": 1347, "state": "open", "locked": true, "title": "Amazing new feature", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Please pull these awesome changes in!", "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "active_lock_reason": "too heated", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true } ], "requested_reviewers": [ { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false } ], "requested_teams": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "head": { "label": "octocat:new-topic", "ref": "new-topic", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } }, "base": { "label": "octocat:master", "ref": "master", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } }, "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1347" }, "issue": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, "comments": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "review_comments": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" }, "review_comment": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "commits": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" }, "statuses": { "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } }, "author_association": "OWNER", "auto_merge": null, "draft": false } ], "schema": { "type": "array", "items": { "title": "Pull Request Simple", "description": "Pull Request Simple", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDExOlB1bGxSZXF1ZXN0MQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347" ] }, "diff_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.diff" ] }, "patch_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.patch" ] }, "issue_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] }, "commits_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" ] }, "review_comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" ] }, "review_comment_url": { "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "number": { "type": "integer", "examples": [ 1347 ] }, "state": { "type": "string", "examples": [ "open" ] }, "locked": { "type": "boolean", "examples": [ true ] }, "title": { "type": "string", "examples": [ "new-feature" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "type": [ "string", "null" ], "examples": [ "Please pull these awesome changes" ] }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "default": { "type": "boolean" } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "active_lock_reason": { "type": [ "string", "null" ], "examples": [ "too heated" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merged_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merge_commit_sha": { "type": [ "string", "null" ], "examples": [ "e5bd3914e2e596debea16f433f57875b5b90bcd6" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_reviewers": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_teams": { "type": [ "array", "null" ], "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "base": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "_links": { "type": "object", "properties": { "comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "commits": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "statuses": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "html": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "issue": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comment": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "self": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "comments", "commits", "statuses", "html", "issue", "review_comments", "review_comment", "self" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "auto_merge": { "title": "Auto merge", "description": "The status of auto merging a pull request.", "type": [ "object", "null" ], "properties": { "enabled_by": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "merge_method": { "type": "string", "description": "The merge method to use.", "enum": [ "merge", "squash", "rebase" ] }, "commit_title": { "type": "string", "description": "Title for the merge commit message." }, "commit_message": { "type": "string", "description": "Commit message for the merge commit." } }, "required": [ "enabled_by", "merge_method", "commit_title", "commit_message" ] }, "draft": { "description": "Indicates whether or not the pull request is a draft.", "type": "boolean", "examples": [ false ] } }, "required": [ "_links", "assignee", "labels", "base", "body", "closed_at", "comments_url", "commits_url", "created_at", "diff_url", "head", "html_url", "id", "node_id", "issue_url", "merge_commit_sha", "merged_at", "milestone", "number", "patch_url", "review_comment_url", "review_comments_url", "statuses_url", "state", "locked", "title", "updated_at", "url", "user", "author_association", "auto_merge" ] } } } } ], "previews": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls", "title": "Create a pull request", "category": "pulls", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "title", "in": "body", "description": "The title of the new pull request. Required unless issue is specified.
The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.
The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.
", "isRequired": true }, { "type": "string", "name": "body", "in": "body", "description": "The contents of the pull request.
" }, { "type": "boolean", "name": "maintainer_can_modify", "in": "body", "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "boolean", "name": "draft", "in": "body", "description": "Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.
" }, { "type": "integer", "name": "issue", "in": "body", "description": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.
Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "number": 1347, "state": "open", "locked": true, "title": "Amazing new feature", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Please pull these awesome changes in!", "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "active_lock_reason": "too heated", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true } ], "requested_reviewers": [ { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false } ], "requested_teams": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" } ], "head": { "label": "octocat:new-topic", "ref": "new-topic", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_merge_commit": true, "allow_forking": true, "forks": 123, "open_issues": 123, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "watchers": 123 } }, "base": { "label": "octocat:master", "ref": "master", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_merge_commit": true, "forks": 123, "open_issues": 123, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "watchers": 123 } }, "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1347" }, "issue": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, "comments": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "review_comments": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" }, "review_comment": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "commits": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" }, "statuses": { "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } }, "author_association": "OWNER", "auto_merge": null, "draft": false, "merged": false, "mergeable": true, "rebaseable": true, "mergeable_state": "clean", "merged_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "comments": 10, "review_comments": 0, "maintainer_can_modify": true, "commits": 3, "additions": 100, "deletions": 3, "changed_files": 5 }, "schema": { "type": "object", "title": "Pull Request", "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDExOlB1bGxSZXF1ZXN0MQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347" ] }, "diff_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.diff" ] }, "patch_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.patch" ] }, "issue_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] }, "commits_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" ] }, "review_comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" ] }, "review_comment_url": { "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "number": { "description": "Number uniquely identifying the pull request within its repository.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of this Pull Request. Either `open` or `closed`.", "enum": [ "open", "closed" ], "type": "string", "examples": [ "open" ] }, "locked": { "type": "boolean", "examples": [ true ] }, "title": { "description": "The title of the pull request.", "type": "string", "examples": [ "Amazing new feature" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "type": [ "string", "null" ], "examples": [ "Please pull these awesome changes" ] }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": "string" }, "default": { "type": "boolean" } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "active_lock_reason": { "type": [ "string", "null" ], "examples": [ "too heated" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merged_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merge_commit_sha": { "type": [ "string", "null" ], "examples": [ "e5bd3914e2e596debea16f433f57875b5b90bcd6" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_reviewers": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_teams": { "type": [ "array", "null" ], "items": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "type": [ "object", "null" ], "properties": { "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string", "format": "uri" }, "deployments_url": { "type": "string", "format": "uri" }, "description": { "type": [ "string", "null" ] }, "downloads_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "fork": { "type": "boolean" }, "forks_url": { "type": "string", "format": "uri" }, "full_name": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string", "format": "uri" }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string" }, "name": { "type": "string" }, "notifications_url": { "type": "string" }, "owner": { "type": "object", "properties": { "avatar_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string", "format": "uri" }, "subscription_url": { "type": "string", "format": "uri" }, "tags_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "trees_url": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "clone_url": { "type": "string" }, "default_branch": { "type": "string" }, "forks": { "type": "integer" }, "forks_count": { "type": "integer" }, "git_url": { "type": "string" }, "has_downloads": { "type": "boolean" }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "homepage": { "type": [ "string", "null" ], "format": "uri" }, "language": { "type": [ "string", "null" ] }, "master_branch": { "type": "string" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "description": "The repository visibility: public, private, or internal.", "type": "string" }, "mirror_url": { "type": [ "string", "null" ], "format": "uri" }, "open_issues": { "type": "integer" }, "open_issues_count": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "temp_clone_token": { "type": "string" }, "allow_merge_commit": { "type": "boolean" }, "allow_squash_merge": { "type": "boolean" }, "allow_rebase_merge": { "type": "boolean" }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "url": { "type": [ "string", "null" ], "format": "uri" }, "spdx_id": { "type": [ "string", "null" ] }, "node_id": { "type": "string" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] }, "pushed_at": { "type": "string", "format": "date-time" }, "size": { "type": "integer" }, "ssh_url": { "type": "string" }, "stargazers_count": { "type": "integer" }, "svn_url": { "type": "string", "format": "uri" }, "topics": { "type": "array", "items": { "type": "string" } }, "watchers": { "type": "integer" }, "watchers_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "allow_forking": { "type": "boolean" }, "is_template": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "type": "object", "properties": { "avatar_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "base": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "type": "object", "properties": { "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string", "format": "uri" }, "deployments_url": { "type": "string", "format": "uri" }, "description": { "type": [ "string", "null" ] }, "downloads_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "fork": { "type": "boolean" }, "forks_url": { "type": "string", "format": "uri" }, "full_name": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "is_template": { "type": "boolean" }, "node_id": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string", "format": "uri" }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string" }, "name": { "type": "string" }, "notifications_url": { "type": "string" }, "owner": { "type": "object", "properties": { "avatar_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string", "format": "uri" }, "subscription_url": { "type": "string", "format": "uri" }, "tags_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "trees_url": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "clone_url": { "type": "string" }, "default_branch": { "type": "string" }, "forks": { "type": "integer" }, "forks_count": { "type": "integer" }, "git_url": { "type": "string" }, "has_downloads": { "type": "boolean" }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "homepage": { "type": [ "string", "null" ], "format": "uri" }, "language": { "type": [ "string", "null" ] }, "master_branch": { "type": "string" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "description": "The repository visibility: public, private, or internal.", "type": "string" }, "mirror_url": { "type": [ "string", "null" ], "format": "uri" }, "open_issues": { "type": "integer" }, "open_issues_count": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "temp_clone_token": { "type": "string" }, "allow_merge_commit": { "type": "boolean" }, "allow_squash_merge": { "type": "boolean" }, "allow_rebase_merge": { "type": "boolean" }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "pushed_at": { "type": "string", "format": "date-time" }, "size": { "type": "integer" }, "ssh_url": { "type": "string" }, "stargazers_count": { "type": "integer" }, "svn_url": { "type": "string", "format": "uri" }, "topics": { "type": "array", "items": { "type": "string" } }, "watchers": { "type": "integer" }, "watchers_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "type": "object", "properties": { "avatar_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "_links": { "type": "object", "properties": { "comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "commits": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "statuses": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "html": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "issue": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comment": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "self": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "comments", "commits", "statuses", "html", "issue", "review_comments", "review_comment", "self" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "auto_merge": { "title": "Auto merge", "description": "The status of auto merging a pull request.", "type": [ "object", "null" ], "properties": { "enabled_by": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "merge_method": { "type": "string", "description": "The merge method to use.", "enum": [ "merge", "squash", "rebase" ] }, "commit_title": { "type": "string", "description": "Title for the merge commit message." }, "commit_message": { "type": "string", "description": "Commit message for the merge commit." } }, "required": [ "enabled_by", "merge_method", "commit_title", "commit_message" ] }, "draft": { "description": "Indicates whether or not the pull request is a draft.", "type": "boolean", "examples": [ false ] }, "merged": { "type": "boolean" }, "mergeable": { "type": [ "boolean", "null" ], "examples": [ true ] }, "rebaseable": { "type": [ "boolean", "null" ], "examples": [ true ] }, "mergeable_state": { "type": "string", "examples": [ "clean" ] }, "merged_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "comments": { "type": "integer", "examples": [ 10 ] }, "review_comments": { "type": "integer", "examples": [ 0 ] }, "maintainer_can_modify": { "description": "Indicates whether maintainers can modify the pull request.", "type": "boolean", "examples": [ true ] }, "commits": { "type": "integer", "examples": [ 3 ] }, "additions": { "type": "integer", "examples": [ 100 ] }, "deletions": { "type": "integer", "examples": [ 3 ] }, "changed_files": { "type": "integer", "examples": [ 5 ] } }, "required": [ "_links", "assignee", "labels", "base", "body", "closed_at", "comments_url", "commits_url", "created_at", "diff_url", "head", "html_url", "id", "node_id", "issue_url", "merge_commit_sha", "merged_at", "milestone", "number", "patch_url", "review_comment_url", "review_comments_url", "statuses_url", "state", "locked", "title", "updated_at", "url", "user", "author_association", "auto_merge", "additions", "changed_files", "comments", "commits", "deletions", "mergeable", "mergeable_state", "merged", "maintainer_can_modify", "merged_by", "review_comments" ] } } } ], "previews": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", "title": "Get a pull request", "category": "pulls", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Pass the appropriate media type to fetch diff and patch formats.
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "number": 1347, "state": "open", "locked": true, "title": "Amazing new feature", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Please pull these awesome changes in!", "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "active_lock_reason": "too heated", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true } ], "requested_reviewers": [ { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false } ], "requested_teams": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" } ], "head": { "label": "octocat:new-topic", "ref": "new-topic", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_merge_commit": true, "allow_forking": true, "forks": 123, "open_issues": 123, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "watchers": 123 } }, "base": { "label": "octocat:master", "ref": "master", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_merge_commit": true, "forks": 123, "open_issues": 123, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "watchers": 123 } }, "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1347" }, "issue": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, "comments": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "review_comments": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" }, "review_comment": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "commits": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" }, "statuses": { "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } }, "author_association": "OWNER", "auto_merge": null, "draft": false, "merged": false, "mergeable": true, "rebaseable": true, "mergeable_state": "clean", "merged_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "comments": 10, "review_comments": 0, "maintainer_can_modify": true, "commits": 3, "additions": 100, "deletions": 3, "changed_files": 5 }, "schema": { "type": "object", "title": "Pull Request", "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDExOlB1bGxSZXF1ZXN0MQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347" ] }, "diff_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.diff" ] }, "patch_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.patch" ] }, "issue_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] }, "commits_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" ] }, "review_comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" ] }, "review_comment_url": { "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "number": { "description": "Number uniquely identifying the pull request within its repository.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of this Pull Request. Either `open` or `closed`.", "enum": [ "open", "closed" ], "type": "string", "examples": [ "open" ] }, "locked": { "type": "boolean", "examples": [ true ] }, "title": { "description": "The title of the pull request.", "type": "string", "examples": [ "Amazing new feature" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "type": [ "string", "null" ], "examples": [ "Please pull these awesome changes" ] }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": "string" }, "default": { "type": "boolean" } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "active_lock_reason": { "type": [ "string", "null" ], "examples": [ "too heated" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merged_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merge_commit_sha": { "type": [ "string", "null" ], "examples": [ "e5bd3914e2e596debea16f433f57875b5b90bcd6" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_reviewers": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_teams": { "type": [ "array", "null" ], "items": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "type": [ "object", "null" ], "properties": { "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string", "format": "uri" }, "deployments_url": { "type": "string", "format": "uri" }, "description": { "type": [ "string", "null" ] }, "downloads_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "fork": { "type": "boolean" }, "forks_url": { "type": "string", "format": "uri" }, "full_name": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string", "format": "uri" }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string" }, "name": { "type": "string" }, "notifications_url": { "type": "string" }, "owner": { "type": "object", "properties": { "avatar_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string", "format": "uri" }, "subscription_url": { "type": "string", "format": "uri" }, "tags_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "trees_url": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "clone_url": { "type": "string" }, "default_branch": { "type": "string" }, "forks": { "type": "integer" }, "forks_count": { "type": "integer" }, "git_url": { "type": "string" }, "has_downloads": { "type": "boolean" }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "homepage": { "type": [ "string", "null" ], "format": "uri" }, "language": { "type": [ "string", "null" ] }, "master_branch": { "type": "string" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "description": "The repository visibility: public, private, or internal.", "type": "string" }, "mirror_url": { "type": [ "string", "null" ], "format": "uri" }, "open_issues": { "type": "integer" }, "open_issues_count": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "temp_clone_token": { "type": "string" }, "allow_merge_commit": { "type": "boolean" }, "allow_squash_merge": { "type": "boolean" }, "allow_rebase_merge": { "type": "boolean" }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "url": { "type": [ "string", "null" ], "format": "uri" }, "spdx_id": { "type": [ "string", "null" ] }, "node_id": { "type": "string" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] }, "pushed_at": { "type": "string", "format": "date-time" }, "size": { "type": "integer" }, "ssh_url": { "type": "string" }, "stargazers_count": { "type": "integer" }, "svn_url": { "type": "string", "format": "uri" }, "topics": { "type": "array", "items": { "type": "string" } }, "watchers": { "type": "integer" }, "watchers_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "allow_forking": { "type": "boolean" }, "is_template": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "type": "object", "properties": { "avatar_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "base": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "type": "object", "properties": { "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string", "format": "uri" }, "deployments_url": { "type": "string", "format": "uri" }, "description": { "type": [ "string", "null" ] }, "downloads_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "fork": { "type": "boolean" }, "forks_url": { "type": "string", "format": "uri" }, "full_name": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "is_template": { "type": "boolean" }, "node_id": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string", "format": "uri" }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string" }, "name": { "type": "string" }, "notifications_url": { "type": "string" }, "owner": { "type": "object", "properties": { "avatar_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string", "format": "uri" }, "subscription_url": { "type": "string", "format": "uri" }, "tags_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "trees_url": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "clone_url": { "type": "string" }, "default_branch": { "type": "string" }, "forks": { "type": "integer" }, "forks_count": { "type": "integer" }, "git_url": { "type": "string" }, "has_downloads": { "type": "boolean" }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "homepage": { "type": [ "string", "null" ], "format": "uri" }, "language": { "type": [ "string", "null" ] }, "master_branch": { "type": "string" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "description": "The repository visibility: public, private, or internal.", "type": "string" }, "mirror_url": { "type": [ "string", "null" ], "format": "uri" }, "open_issues": { "type": "integer" }, "open_issues_count": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "temp_clone_token": { "type": "string" }, "allow_merge_commit": { "type": "boolean" }, "allow_squash_merge": { "type": "boolean" }, "allow_rebase_merge": { "type": "boolean" }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "pushed_at": { "type": "string", "format": "date-time" }, "size": { "type": "integer" }, "ssh_url": { "type": "string" }, "stargazers_count": { "type": "integer" }, "svn_url": { "type": "string", "format": "uri" }, "topics": { "type": "array", "items": { "type": "string" } }, "watchers": { "type": "integer" }, "watchers_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "type": "object", "properties": { "avatar_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "_links": { "type": "object", "properties": { "comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "commits": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "statuses": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "html": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "issue": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comment": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "self": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "comments", "commits", "statuses", "html", "issue", "review_comments", "review_comment", "self" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "auto_merge": { "title": "Auto merge", "description": "The status of auto merging a pull request.", "type": [ "object", "null" ], "properties": { "enabled_by": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "merge_method": { "type": "string", "description": "The merge method to use.", "enum": [ "merge", "squash", "rebase" ] }, "commit_title": { "type": "string", "description": "Title for the merge commit message." }, "commit_message": { "type": "string", "description": "Commit message for the merge commit." } }, "required": [ "enabled_by", "merge_method", "commit_title", "commit_message" ] }, "draft": { "description": "Indicates whether or not the pull request is a draft.", "type": "boolean", "examples": [ false ] }, "merged": { "type": "boolean" }, "mergeable": { "type": [ "boolean", "null" ], "examples": [ true ] }, "rebaseable": { "type": [ "boolean", "null" ], "examples": [ true ] }, "mergeable_state": { "type": "string", "examples": [ "clean" ] }, "merged_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "comments": { "type": "integer", "examples": [ 10 ] }, "review_comments": { "type": "integer", "examples": [ 0 ] }, "maintainer_can_modify": { "description": "Indicates whether maintainers can modify the pull request.", "type": "boolean", "examples": [ true ] }, "commits": { "type": "integer", "examples": [ 3 ] }, "additions": { "type": "integer", "examples": [ 100 ] }, "deletions": { "type": "integer", "examples": [ 3 ] }, "changed_files": { "type": "integer", "examples": [ 5 ] } }, "required": [ "_links", "assignee", "labels", "base", "body", "closed_at", "comments_url", "commits_url", "created_at", "diff_url", "head", "html_url", "id", "node_id", "issue_url", "merge_commit_sha", "merged_at", "milestone", "number", "patch_url", "review_comment_url", "review_comments_url", "statuses_url", "state", "locked", "title", "updated_at", "url", "user", "author_association", "auto_merge", "additions", "changed_files", "comments", "commits", "deletions", "mergeable", "mergeable_state", "merged", "maintainer_can_modify", "merged_by", "review_comments" ] } } } ], "previews": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
- \n
- If merged as a merge commit,
merge_commit_sharepresents the SHA of the merge commit. \n - If merged via a squash,
merge_commit_sharepresents the SHA of the squashed commit on the base branch. \n - If rebased,
merge_commit_sharepresents the commit that the base branch was updated to. \n
Pass the appropriate media type to fetch diff and patch formats.
", "statusCodes": [ { "httpStatusCode": "200", "description": "Pass the appropriate media type to fetch diff and patch formats.
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", "title": "Update a pull request", "category": "pulls", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "title", "in": "body", "description": "The title of the pull request.
" }, { "type": "string", "name": "body", "in": "body", "description": "The contents of the pull request.
" }, { "type": "string", "name": "state", "in": "body", "description": "State of this Pull Request. Either open or closed.
The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.
" }, { "type": "boolean", "name": "maintainer_can_modify", "in": "body", "description": "Indicates whether maintainers can modify the pull request.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "new title", "body": "updated body", "state": "open", "base": "master" }, "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "number": 1347, "state": "open", "locked": true, "title": "Amazing new feature", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Please pull these awesome changes in!", "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "active_lock_reason": "too heated", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true } ], "requested_reviewers": [ { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false } ], "requested_teams": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" } ], "head": { "label": "octocat:new-topic", "ref": "new-topic", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_merge_commit": true, "allow_forking": true, "forks": 123, "open_issues": 123, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "watchers": 123 } }, "base": { "label": "octocat:master", "ref": "master", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_merge_commit": true, "forks": 123, "open_issues": 123, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "watchers": 123 } }, "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1347" }, "issue": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, "comments": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "review_comments": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" }, "review_comment": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "commits": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" }, "statuses": { "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } }, "author_association": "OWNER", "auto_merge": null, "draft": false, "merged": false, "mergeable": true, "rebaseable": true, "mergeable_state": "clean", "merged_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "comments": 10, "review_comments": 0, "maintainer_can_modify": true, "commits": 3, "additions": 100, "deletions": 3, "changed_files": 5 }, "schema": { "type": "object", "title": "Pull Request", "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDExOlB1bGxSZXF1ZXN0MQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347" ] }, "diff_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.diff" ] }, "patch_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.patch" ] }, "issue_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] }, "commits_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" ] }, "review_comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" ] }, "review_comment_url": { "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "number": { "description": "Number uniquely identifying the pull request within its repository.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "State of this Pull Request. Either `open` or `closed`.", "enum": [ "open", "closed" ], "type": "string", "examples": [ "open" ] }, "locked": { "type": "boolean", "examples": [ true ] }, "title": { "description": "The title of the pull request.", "type": "string", "examples": [ "Amazing new feature" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "type": [ "string", "null" ], "examples": [ "Please pull these awesome changes" ] }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": "string" }, "default": { "type": "boolean" } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "active_lock_reason": { "type": [ "string", "null" ], "examples": [ "too heated" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merged_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merge_commit_sha": { "type": [ "string", "null" ], "examples": [ "e5bd3914e2e596debea16f433f57875b5b90bcd6" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_reviewers": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_teams": { "type": [ "array", "null" ], "items": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "type": [ "object", "null" ], "properties": { "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string", "format": "uri" }, "deployments_url": { "type": "string", "format": "uri" }, "description": { "type": [ "string", "null" ] }, "downloads_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "fork": { "type": "boolean" }, "forks_url": { "type": "string", "format": "uri" }, "full_name": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string", "format": "uri" }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string" }, "name": { "type": "string" }, "notifications_url": { "type": "string" }, "owner": { "type": "object", "properties": { "avatar_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string", "format": "uri" }, "subscription_url": { "type": "string", "format": "uri" }, "tags_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "trees_url": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "clone_url": { "type": "string" }, "default_branch": { "type": "string" }, "forks": { "type": "integer" }, "forks_count": { "type": "integer" }, "git_url": { "type": "string" }, "has_downloads": { "type": "boolean" }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "homepage": { "type": [ "string", "null" ], "format": "uri" }, "language": { "type": [ "string", "null" ] }, "master_branch": { "type": "string" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "description": "The repository visibility: public, private, or internal.", "type": "string" }, "mirror_url": { "type": [ "string", "null" ], "format": "uri" }, "open_issues": { "type": "integer" }, "open_issues_count": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "temp_clone_token": { "type": "string" }, "allow_merge_commit": { "type": "boolean" }, "allow_squash_merge": { "type": "boolean" }, "allow_rebase_merge": { "type": "boolean" }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "url": { "type": [ "string", "null" ], "format": "uri" }, "spdx_id": { "type": [ "string", "null" ] }, "node_id": { "type": "string" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] }, "pushed_at": { "type": "string", "format": "date-time" }, "size": { "type": "integer" }, "ssh_url": { "type": "string" }, "stargazers_count": { "type": "integer" }, "svn_url": { "type": "string", "format": "uri" }, "topics": { "type": "array", "items": { "type": "string" } }, "watchers": { "type": "integer" }, "watchers_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "allow_forking": { "type": "boolean" }, "is_template": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "type": "object", "properties": { "avatar_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "base": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "type": "object", "properties": { "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string", "format": "uri" }, "deployments_url": { "type": "string", "format": "uri" }, "description": { "type": [ "string", "null" ] }, "downloads_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "fork": { "type": "boolean" }, "forks_url": { "type": "string", "format": "uri" }, "full_name": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "is_template": { "type": "boolean" }, "node_id": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string", "format": "uri" }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string" }, "name": { "type": "string" }, "notifications_url": { "type": "string" }, "owner": { "type": "object", "properties": { "avatar_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string", "format": "uri" }, "subscription_url": { "type": "string", "format": "uri" }, "tags_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "trees_url": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "clone_url": { "type": "string" }, "default_branch": { "type": "string" }, "forks": { "type": "integer" }, "forks_count": { "type": "integer" }, "git_url": { "type": "string" }, "has_downloads": { "type": "boolean" }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "homepage": { "type": [ "string", "null" ], "format": "uri" }, "language": { "type": [ "string", "null" ] }, "master_branch": { "type": "string" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "description": "The repository visibility: public, private, or internal.", "type": "string" }, "mirror_url": { "type": [ "string", "null" ], "format": "uri" }, "open_issues": { "type": "integer" }, "open_issues_count": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "temp_clone_token": { "type": "string" }, "allow_merge_commit": { "type": "boolean" }, "allow_squash_merge": { "type": "boolean" }, "allow_rebase_merge": { "type": "boolean" }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "pushed_at": { "type": "string", "format": "date-time" }, "size": { "type": "integer" }, "ssh_url": { "type": "string" }, "stargazers_count": { "type": "integer" }, "svn_url": { "type": "string", "format": "uri" }, "topics": { "type": "array", "items": { "type": "string" } }, "watchers": { "type": "integer" }, "watchers_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "type": "object", "properties": { "avatar_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "gravatar_id": { "type": [ "string", "null" ] }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "login": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "_links": { "type": "object", "properties": { "comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "commits": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "statuses": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "html": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "issue": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comment": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "self": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "comments", "commits", "statuses", "html", "issue", "review_comments", "review_comment", "self" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "auto_merge": { "title": "Auto merge", "description": "The status of auto merging a pull request.", "type": [ "object", "null" ], "properties": { "enabled_by": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "merge_method": { "type": "string", "description": "The merge method to use.", "enum": [ "merge", "squash", "rebase" ] }, "commit_title": { "type": "string", "description": "Title for the merge commit message." }, "commit_message": { "type": "string", "description": "Commit message for the merge commit." } }, "required": [ "enabled_by", "merge_method", "commit_title", "commit_message" ] }, "draft": { "description": "Indicates whether or not the pull request is a draft.", "type": "boolean", "examples": [ false ] }, "merged": { "type": "boolean" }, "mergeable": { "type": [ "boolean", "null" ], "examples": [ true ] }, "rebaseable": { "type": [ "boolean", "null" ], "examples": [ true ] }, "mergeable_state": { "type": "string", "examples": [ "clean" ] }, "merged_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "comments": { "type": "integer", "examples": [ 10 ] }, "review_comments": { "type": "integer", "examples": [ 0 ] }, "maintainer_can_modify": { "description": "Indicates whether maintainers can modify the pull request.", "type": "boolean", "examples": [ true ] }, "commits": { "type": "integer", "examples": [ 3 ] }, "additions": { "type": "integer", "examples": [ 100 ] }, "deletions": { "type": "integer", "examples": [ 3 ] }, "changed_files": { "type": "integer", "examples": [ 5 ] } }, "required": [ "_links", "assignee", "labels", "base", "body", "closed_at", "comments_url", "commits_url", "created_at", "diff_url", "head", "html_url", "id", "node_id", "issue_url", "merge_commit_sha", "merged_at", "milestone", "number", "patch_url", "review_comment_url", "review_comments_url", "statuses_url", "state", "locked", "title", "updated_at", "url", "user", "author_association", "auto_merge", "additions", "changed_files", "comments", "commits", "deletions", "mergeable", "mergeable_state", "merged", "maintainer_can_modify", "merged_by", "review_comments" ] } } } ], "previews": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", "title": "List commits on a pull request", "category": "pulls", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", "commit": { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "author": { "name": "Monalisa Octocat", "email": "support@github.com", "date": "2011-04-14T16:00:49Z" }, "committer": { "name": "Monalisa Octocat", "email": "support@github.com", "date": "2011-04-14T16:00:49Z" }, "message": "Fix all the bugs", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" }, "comment_count": 0, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "committer": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" } ] } ], "schema": { "type": "array", "items": { "title": "Commit", "description": "Commit", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "sha": { "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "node_id": { "type": "string", "examples": [ "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" ] }, "commit": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "message": { "type": "string", "examples": [ "Fix all the bugs" ] }, "comment_count": { "type": "integer", "examples": [ 0 ] }, "tree": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "827efc6d56897b048c772eb4087f854f46256132" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" ] } }, "required": [ "sha", "url" ] }, "verification": { "title": "Verification", "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "payload": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "payload", "signature" ] } }, "required": [ "author", "committer", "comment_count", "message", "tree", "url" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "sha": { "type": "string", "examples": [ "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" ] } }, "required": [ "sha", "url" ] } }, "stats": { "type": "object", "properties": { "additions": { "type": "integer" }, "deletions": { "type": "integer" }, "total": { "type": "integer" } } }, "files": { "type": "array", "items": { "title": "Diff Entry", "description": "Diff Entry", "type": "object", "properties": { "sha": { "type": "string", "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] }, "filename": { "type": "string", "examples": [ "file1.txt" ] }, "status": { "type": "string", "enum": [ "added", "removed", "modified", "renamed", "copied", "changed", "unchanged" ], "examples": [ "added" ] }, "additions": { "type": "integer", "examples": [ 103 ] }, "deletions": { "type": "integer", "examples": [ 21 ] }, "changes": { "type": "integer", "examples": [ 124 ] }, "blob_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "raw_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "contents_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "patch": { "type": "string", "examples": [ "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" ] }, "previous_filename": { "type": "string", "examples": [ "file.txt" ] } }, "required": [ "additions", "blob_url", "changes", "contents_url", "deletions", "filename", "raw_url", "sha", "status" ] } } }, "required": [ "url", "sha", "node_id", "html_url", "comments_url", "commit", "author", "committer", "parents" ] } } } } ], "previews": [], "descriptionHTML": "Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files", "title": "List pull requests files", "category": "pulls", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", "filename": "file1.txt", "status": "added", "additions": 103, "deletions": 21, "changes": 124, "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e", "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" } ], "schema": { "type": "array", "items": { "title": "Diff Entry", "description": "Diff Entry", "type": "object", "properties": { "sha": { "type": "string", "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] }, "filename": { "type": "string", "examples": [ "file1.txt" ] }, "status": { "type": "string", "enum": [ "added", "removed", "modified", "renamed", "copied", "changed", "unchanged" ], "examples": [ "added" ] }, "additions": { "type": "integer", "examples": [ 103 ] }, "deletions": { "type": "integer", "examples": [ 21 ] }, "changes": { "type": "integer", "examples": [ 124 ] }, "blob_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "raw_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, "contents_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "patch": { "type": "string", "examples": [ "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" ] }, "previous_filename": { "type": "string", "examples": [ "file.txt" ] } }, "required": [ "additions", "blob_url", "changes", "contents_url", "deletions", "filename", "raw_url", "sha", "status" ] } } } } ], "previews": [], "descriptionHTML": "Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "500", "description": "Internal Error
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", "title": "Check if a pull request has been merged", "category": "pulls", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "204", "description": "Response if pull request has been merged
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "Response if pull request has been merged
" }, { "httpStatusCode": "404", "description": "Not Found if pull request has not been merged
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", "title": "Merge a pull request", "category": "pulls", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "commit_title", "in": "body", "description": "Title for the automatic commit message.
" }, { "type": "string", "name": "commit_message", "in": "body", "description": "Extra detail to append to automatic commit message.
" }, { "type": "string", "name": "sha", "in": "body", "description": "SHA that pull request head must match to allow merge.
" }, { "type": "string", "name": "merge_method", "in": "body", "description": "Merge method to use. Possible values are merge, squash or rebase. Default is merge.
if merge was successful
", "example": { "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "merged": true, "message": "Pull Request successfully merged" }, "schema": { "title": "Pull Request Merge Result", "description": "Pull Request Merge Result", "type": "object", "properties": { "sha": { "type": "string" }, "merged": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "merged", "message", "sha" ] } } } ], "previews": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "200", "description": "if merge was successful
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "405", "description": "Method Not Allowed if merge cannot be performed
" }, { "httpStatusCode": "409", "description": "Conflict if sha was provided and pull request head did not match
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", "title": "Update a pull request branch", "category": "pulls", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "expected_head_sha", "in": "body", "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.
Response
", "example": { "message": "Updating pull request branch.", "url": "https://github.com/repos/octocat/Hello-World/pulls/53" }, "schema": { "type": "object", "properties": { "message": { "type": "string" }, "url": { "type": "string" } } } } } ], "previews": [], "descriptionHTML": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
", "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pulls" } ], "comments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments", "title": "List review comments in a repository", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated", "created_at" ] }, "description": "" }, { "name": "direction", "description": "Can be either asc or desc. Ignored without sort parameter.
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" } ], "schema": { "type": "array", "items": { "title": "Pull Request Review Comment", "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", "type": "object", "properties": { "url": { "description": "URL for the pull request review comment", "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", "type": [ "integer", "null" ], "examples": [ 42 ] }, "id": { "description": "The ID of the pull request review comment.", "type": "integer", "examples": [ 1 ] }, "node_id": { "description": "The node ID of the pull request review comment.", "type": "string", "examples": [ "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" ] }, "diff_hunk": { "description": "The diff of the line that the comment refers to.", "type": "string", "examples": [ "@@ -16,33 +16,40 @@ public class Connection : IConnection..." ] }, "path": { "description": "The relative path of the file to which the comment applies.", "type": "string", "examples": [ "config/database.yaml" ] }, "position": { "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 ] }, "commit_id": { "description": "The SHA of the commit to which the comment applies.", "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "original_commit_id": { "description": "The SHA of the original commit to which the comment applies.", "type": "string", "examples": [ "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840" ] }, "in_reply_to_id": { "description": "The comment ID to reply to.", "type": "integer", "examples": [ 8 ] }, "user": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "body": { "description": "The text of the comment.", "type": "string", "examples": [ "We should probably include a check for null values here." ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "html_url": { "description": "HTML URL for the pull request review comment.", "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] }, "pull_request_url": { "description": "URL for the pull request that the review comment belongs to.", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] } }, "required": [ "href" ] }, "html": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] } }, "required": [ "href" ] } }, "required": [ "self", "html", "pull_request" ] }, "start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "original_start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "start_side": { "type": [ "string", "null" ], "description": "The side of the first line of the range for a multi-line comment.", "enum": [ "LEFT", "RIGHT", null ], "default": "RIGHT" }, "line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "side": { "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", "enum": [ "LEFT", "RIGHT" ], "default": "RIGHT", "type": "string" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "body_html": { "type": "string", "examples": [ "\"comment body
\"" ] }, "body_text": { "type": "string", "examples": [ "\"comment body\"" ] } }, "required": [ "url", "id", "node_id", "pull_request_review_id", "diff_hunk", "path", "position", "original_position", "commit_id", "original_commit_id", "user", "body", "created_at", "updated_at", "html_url", "pull_request_url", "author_association", "_links" ] } } } } ], "previews": [], "descriptionHTML": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", "title": "Get a review comment for a pull request", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" }, "schema": { "title": "Pull Request Review Comment", "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", "type": "object", "properties": { "url": { "description": "URL for the pull request review comment", "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", "type": [ "integer", "null" ], "examples": [ 42 ] }, "id": { "description": "The ID of the pull request review comment.", "type": "integer", "examples": [ 1 ] }, "node_id": { "description": "The node ID of the pull request review comment.", "type": "string", "examples": [ "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" ] }, "diff_hunk": { "description": "The diff of the line that the comment refers to.", "type": "string", "examples": [ "@@ -16,33 +16,40 @@ public class Connection : IConnection..." ] }, "path": { "description": "The relative path of the file to which the comment applies.", "type": "string", "examples": [ "config/database.yaml" ] }, "position": { "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 ] }, "commit_id": { "description": "The SHA of the commit to which the comment applies.", "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "original_commit_id": { "description": "The SHA of the original commit to which the comment applies.", "type": "string", "examples": [ "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840" ] }, "in_reply_to_id": { "description": "The comment ID to reply to.", "type": "integer", "examples": [ 8 ] }, "user": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "body": { "description": "The text of the comment.", "type": "string", "examples": [ "We should probably include a check for null values here." ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "html_url": { "description": "HTML URL for the pull request review comment.", "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] }, "pull_request_url": { "description": "URL for the pull request that the review comment belongs to.", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] } }, "required": [ "href" ] }, "html": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] } }, "required": [ "href" ] } }, "required": [ "self", "html", "pull_request" ] }, "start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "original_start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "start_side": { "type": [ "string", "null" ], "description": "The side of the first line of the range for a multi-line comment.", "enum": [ "LEFT", "RIGHT", null ], "default": "RIGHT" }, "line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "side": { "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", "enum": [ "LEFT", "RIGHT" ], "default": "RIGHT", "type": "string" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "body_html": { "type": "string", "examples": [ "\"comment body
\"" ] }, "body_text": { "type": "string", "examples": [ "\"comment body\"" ] } }, "required": [ "url", "id", "node_id", "pull_request_review_id", "diff_hunk", "path", "position", "original_position", "commit_id", "original_commit_id", "user", "body", "created_at", "updated_at", "html_url", "pull_request_url", "author_association", "_links" ] } } } ], "previews": [], "descriptionHTML": "Provides details for a review comment.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", "title": "Update a review comment for a pull request", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The text of the reply to the review comment.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "I like this too!" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" }, "schema": { "title": "Pull Request Review Comment", "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", "type": "object", "properties": { "url": { "description": "URL for the pull request review comment", "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", "type": [ "integer", "null" ], "examples": [ 42 ] }, "id": { "description": "The ID of the pull request review comment.", "type": "integer", "examples": [ 1 ] }, "node_id": { "description": "The node ID of the pull request review comment.", "type": "string", "examples": [ "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" ] }, "diff_hunk": { "description": "The diff of the line that the comment refers to.", "type": "string", "examples": [ "@@ -16,33 +16,40 @@ public class Connection : IConnection..." ] }, "path": { "description": "The relative path of the file to which the comment applies.", "type": "string", "examples": [ "config/database.yaml" ] }, "position": { "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 ] }, "commit_id": { "description": "The SHA of the commit to which the comment applies.", "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "original_commit_id": { "description": "The SHA of the original commit to which the comment applies.", "type": "string", "examples": [ "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840" ] }, "in_reply_to_id": { "description": "The comment ID to reply to.", "type": "integer", "examples": [ 8 ] }, "user": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "body": { "description": "The text of the comment.", "type": "string", "examples": [ "We should probably include a check for null values here." ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "html_url": { "description": "HTML URL for the pull request review comment.", "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] }, "pull_request_url": { "description": "URL for the pull request that the review comment belongs to.", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] } }, "required": [ "href" ] }, "html": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] } }, "required": [ "href" ] } }, "required": [ "self", "html", "pull_request" ] }, "start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "original_start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "start_side": { "type": [ "string", "null" ], "description": "The side of the first line of the range for a multi-line comment.", "enum": [ "LEFT", "RIGHT", null ], "default": "RIGHT" }, "line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "side": { "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", "enum": [ "LEFT", "RIGHT" ], "default": "RIGHT", "type": "string" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "body_html": { "type": "string", "examples": [ "\"comment body
\"" ] }, "body_text": { "type": "string", "examples": [ "\"comment body\"" ] } }, "required": [ "url", "id", "node_id", "pull_request_review_id", "diff_hunk", "path", "position", "original_position", "commit_id", "original_commit_id", "user", "body", "created_at", "updated_at", "html_url", "pull_request_url", "author_association", "_links" ] } } } ], "previews": [], "descriptionHTML": "Enables you to edit a review comment.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", "title": "Delete a review comment for a pull request", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a review comment.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", "title": "List review comments on a pull request", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "sort", "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
Can be either asc or desc. Ignored without sort parameter.
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" } ], "schema": { "type": "array", "items": { "title": "Pull Request Review Comment", "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", "type": "object", "properties": { "url": { "description": "URL for the pull request review comment", "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", "type": [ "integer", "null" ], "examples": [ 42 ] }, "id": { "description": "The ID of the pull request review comment.", "type": "integer", "examples": [ 1 ] }, "node_id": { "description": "The node ID of the pull request review comment.", "type": "string", "examples": [ "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" ] }, "diff_hunk": { "description": "The diff of the line that the comment refers to.", "type": "string", "examples": [ "@@ -16,33 +16,40 @@ public class Connection : IConnection..." ] }, "path": { "description": "The relative path of the file to which the comment applies.", "type": "string", "examples": [ "config/database.yaml" ] }, "position": { "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 ] }, "commit_id": { "description": "The SHA of the commit to which the comment applies.", "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "original_commit_id": { "description": "The SHA of the original commit to which the comment applies.", "type": "string", "examples": [ "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840" ] }, "in_reply_to_id": { "description": "The comment ID to reply to.", "type": "integer", "examples": [ 8 ] }, "user": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "body": { "description": "The text of the comment.", "type": "string", "examples": [ "We should probably include a check for null values here." ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "html_url": { "description": "HTML URL for the pull request review comment.", "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] }, "pull_request_url": { "description": "URL for the pull request that the review comment belongs to.", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] } }, "required": [ "href" ] }, "html": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] } }, "required": [ "href" ] } }, "required": [ "self", "html", "pull_request" ] }, "start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "original_start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "start_side": { "type": [ "string", "null" ], "description": "The side of the first line of the range for a multi-line comment.", "enum": [ "LEFT", "RIGHT", null ], "default": "RIGHT" }, "line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "side": { "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", "enum": [ "LEFT", "RIGHT" ], "default": "RIGHT", "type": "string" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "body_html": { "type": "string", "examples": [ "\"comment body
\"" ] }, "body_text": { "type": "string", "examples": [ "\"comment body\"" ] } }, "required": [ "url", "id", "node_id", "pull_request_review_id", "diff_hunk", "path", "position", "original_position", "commit_id", "original_commit_id", "user", "body", "created_at", "updated_at", "html_url", "pull_request_url", "author_association", "_links" ] } } } } ], "previews": [], "descriptionHTML": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", "title": "Create a review comment for a pull request", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The text of the review comment.
", "isRequired": true }, { "type": "string", "name": "commit_id", "in": "body", "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.
The relative path to the file that necessitates a comment.
", "isRequired": true }, { "type": "integer", "name": "position", "in": "body", "description": "This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.
The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.
", "isRequired": true }, { "type": "integer", "name": "start_line", "in": "body", "description": "Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.
Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.
The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.
Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" }, "schema": { "title": "Pull Request Review Comment", "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", "type": "object", "properties": { "url": { "description": "URL for the pull request review comment", "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", "type": [ "integer", "null" ], "examples": [ 42 ] }, "id": { "description": "The ID of the pull request review comment.", "type": "integer", "examples": [ 1 ] }, "node_id": { "description": "The node ID of the pull request review comment.", "type": "string", "examples": [ "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" ] }, "diff_hunk": { "description": "The diff of the line that the comment refers to.", "type": "string", "examples": [ "@@ -16,33 +16,40 @@ public class Connection : IConnection..." ] }, "path": { "description": "The relative path of the file to which the comment applies.", "type": "string", "examples": [ "config/database.yaml" ] }, "position": { "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 ] }, "commit_id": { "description": "The SHA of the commit to which the comment applies.", "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "original_commit_id": { "description": "The SHA of the original commit to which the comment applies.", "type": "string", "examples": [ "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840" ] }, "in_reply_to_id": { "description": "The comment ID to reply to.", "type": "integer", "examples": [ 8 ] }, "user": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "body": { "description": "The text of the comment.", "type": "string", "examples": [ "We should probably include a check for null values here." ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "html_url": { "description": "HTML URL for the pull request review comment.", "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] }, "pull_request_url": { "description": "URL for the pull request that the review comment belongs to.", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] } }, "required": [ "href" ] }, "html": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] } }, "required": [ "href" ] } }, "required": [ "self", "html", "pull_request" ] }, "start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "original_start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "start_side": { "type": [ "string", "null" ], "description": "The side of the first line of the range for a multi-line comment.", "enum": [ "LEFT", "RIGHT", null ], "default": "RIGHT" }, "line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "side": { "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", "enum": [ "LEFT", "RIGHT" ], "default": "RIGHT", "type": "string" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "body_html": { "type": "string", "examples": [ "\"comment body
\"" ] }, "body_text": { "type": "string", "examples": [ "\"comment body\"" ] } }, "required": [ "url", "id", "node_id", "pull_request_review_id", "diff_hunk", "path", "position", "original_position", "commit_id", "original_commit_id", "user", "body", "created_at", "updated_at", "html_url", "pull_request_url", "author_association", "_links" ] } } } ], "previews": [], "descriptionHTML": "Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", "title": "Create a reply for a review comment", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The text of the review comment.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!" }, "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 426899381, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" }, "schema": { "title": "Pull Request Review Comment", "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", "type": "object", "properties": { "url": { "description": "URL for the pull request review comment", "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", "type": [ "integer", "null" ], "examples": [ 42 ] }, "id": { "description": "The ID of the pull request review comment.", "type": "integer", "examples": [ 1 ] }, "node_id": { "description": "The node ID of the pull request review comment.", "type": "string", "examples": [ "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" ] }, "diff_hunk": { "description": "The diff of the line that the comment refers to.", "type": "string", "examples": [ "@@ -16,33 +16,40 @@ public class Connection : IConnection..." ] }, "path": { "description": "The relative path of the file to which the comment applies.", "type": "string", "examples": [ "config/database.yaml" ] }, "position": { "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 ] }, "commit_id": { "description": "The SHA of the commit to which the comment applies.", "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "original_commit_id": { "description": "The SHA of the original commit to which the comment applies.", "type": "string", "examples": [ "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840" ] }, "in_reply_to_id": { "description": "The comment ID to reply to.", "type": "integer", "examples": [ 8 ] }, "user": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "body": { "description": "The text of the comment.", "type": "string", "examples": [ "We should probably include a check for null values here." ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "html_url": { "description": "HTML URL for the pull request review comment.", "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] }, "pull_request_url": { "description": "URL for the pull request that the review comment belongs to.", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] } }, "required": [ "href" ] }, "html": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] } }, "required": [ "href" ] } }, "required": [ "self", "html", "pull_request" ] }, "start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "original_start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment.", "examples": [ 2 ] }, "start_side": { "type": [ "string", "null" ], "description": "The side of the first line of the range for a multi-line comment.", "enum": [ "LEFT", "RIGHT", null ], "default": "RIGHT" }, "line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "side": { "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", "enum": [ "LEFT", "RIGHT" ], "default": "RIGHT", "type": "string" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "body_html": { "type": "string", "examples": [ "\"comment body
\"" ] }, "body_text": { "type": "string", "examples": [ "\"comment body\"" ] } }, "required": [ "url", "id", "node_id", "pull_request_review_id", "diff_hunk", "path", "position", "original_position", "commit_id", "original_commit_id", "user", "body", "created_at", "updated_at", "html_url", "pull_request_url", "author_association", "_links" ] } } } ], "previews": [], "descriptionHTML": "Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "review-requests": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "title": "Get all requested reviewers for a pull request", "category": "pulls", "subcategory": "review-requests", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "users": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "teams": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ] }, "schema": { "title": "Pull Request Review Request", "description": "Pull Request Review Request", "type": "object", "properties": { "users": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "teams": { "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } } }, "required": [ "users", "teams" ] } } } ], "previews": [], "descriptionHTML": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "title": "Request reviewers for a pull request", "category": "pulls", "subcategory": "review-requests", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of strings", "name": "reviewers", "in": "body", "description": "An array of user logins that will be requested.
An array of team slugs that will be requested.
Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "number": 1347, "state": "open", "locked": true, "title": "Amazing new feature", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Please pull these awesome changes in!", "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "active_lock_reason": "too heated", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true } ], "requested_reviewers": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true }, { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false } ], "requested_teams": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "head": { "label": "octocat:new-topic", "ref": "new-topic", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } }, "base": { "label": "octocat:master", "ref": "master", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } }, "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1347" }, "issue": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, "comments": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "review_comments": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" }, "review_comment": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "commits": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" }, "statuses": { "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } }, "author_association": "OWNER", "auto_merge": null, "draft": false }, "schema": { "title": "Pull Request Simple", "description": "Pull Request Simple", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDExOlB1bGxSZXF1ZXN0MQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347" ] }, "diff_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.diff" ] }, "patch_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.patch" ] }, "issue_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] }, "commits_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" ] }, "review_comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" ] }, "review_comment_url": { "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "number": { "type": "integer", "examples": [ 1347 ] }, "state": { "type": "string", "examples": [ "open" ] }, "locked": { "type": "boolean", "examples": [ true ] }, "title": { "type": "string", "examples": [ "new-feature" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "type": [ "string", "null" ], "examples": [ "Please pull these awesome changes" ] }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "default": { "type": "boolean" } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "active_lock_reason": { "type": [ "string", "null" ], "examples": [ "too heated" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merged_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merge_commit_sha": { "type": [ "string", "null" ], "examples": [ "e5bd3914e2e596debea16f433f57875b5b90bcd6" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_reviewers": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_teams": { "type": [ "array", "null" ], "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "base": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "_links": { "type": "object", "properties": { "comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "commits": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "statuses": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "html": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "issue": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comment": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "self": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "comments", "commits", "statuses", "html", "issue", "review_comments", "review_comment", "self" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "auto_merge": { "title": "Auto merge", "description": "The status of auto merging a pull request.", "type": [ "object", "null" ], "properties": { "enabled_by": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "merge_method": { "type": "string", "description": "The merge method to use.", "enum": [ "merge", "squash", "rebase" ] }, "commit_title": { "type": "string", "description": "Title for the merge commit message." }, "commit_message": { "type": "string", "description": "Commit message for the merge commit." } }, "required": [ "enabled_by", "merge_method", "commit_title", "commit_message" ] }, "draft": { "description": "Indicates whether or not the pull request is a draft.", "type": "boolean", "examples": [ false ] } }, "required": [ "_links", "assignee", "labels", "base", "body", "closed_at", "comments_url", "commits_url", "created_at", "diff_url", "head", "html_url", "id", "node_id", "issue_url", "merge_commit_sha", "merged_at", "milestone", "number", "patch_url", "review_comment_url", "review_comments_url", "statuses_url", "state", "locked", "title", "updated_at", "url", "user", "author_association", "auto_merge" ] } } } ], "previews": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Unprocessable Entity if user is not a collaborator
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "title": "Remove requested reviewers from a pull request", "category": "pulls", "subcategory": "review-requests", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of strings", "name": "reviewers", "in": "body", "description": "An array of user logins that will be removed.
An array of team slugs that will be removed.
Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "number": 1347, "state": "open", "locked": true, "title": "Amazing new feature", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Please pull these awesome changes in!", "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "active_lock_reason": "too heated", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true } ], "requested_reviewers": [ { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false } ], "requested_teams": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "head": { "label": "octocat:new-topic", "ref": "new-topic", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } }, "base": { "label": "octocat:master", "ref": "master", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repo": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } }, "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1347" }, "issue": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, "comments": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "review_comments": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" }, "review_comment": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "commits": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" }, "statuses": { "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } }, "author_association": "OWNER", "auto_merge": null, "draft": false }, "schema": { "title": "Pull Request Simple", "description": "Pull Request Simple", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDExOlB1bGxSZXF1ZXN0MQ==" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347" ] }, "diff_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.diff" ] }, "patch_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.patch" ] }, "issue_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] }, "commits_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" ] }, "review_comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" ] }, "review_comment_url": { "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "number": { "type": "integer", "examples": [ 1347 ] }, "state": { "type": "string", "examples": [ "open" ] }, "locked": { "type": "boolean", "examples": [ true ] }, "title": { "type": "string", "examples": [ "new-feature" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "type": [ "string", "null" ], "examples": [ "Please pull these awesome changes" ] }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "default": { "type": "boolean" } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "active_lock_reason": { "type": [ "string", "null" ], "examples": [ "too heated" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merged_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "merge_commit_sha": { "type": [ "string", "null" ], "examples": [ "e5bd3914e2e596debea16f433f57875b5b90bcd6" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_reviewers": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "requested_teams": { "type": [ "array", "null" ], "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "base": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "label", "ref", "repo", "sha", "user" ] }, "_links": { "type": "object", "properties": { "comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "commits": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "statuses": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "html": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "issue": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comments": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "review_comment": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "self": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "comments", "commits", "statuses", "html", "issue", "review_comments", "review_comment", "self" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "auto_merge": { "title": "Auto merge", "description": "The status of auto merging a pull request.", "type": [ "object", "null" ], "properties": { "enabled_by": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "merge_method": { "type": "string", "description": "The merge method to use.", "enum": [ "merge", "squash", "rebase" ] }, "commit_title": { "type": "string", "description": "Title for the merge commit message." }, "commit_message": { "type": "string", "description": "Commit message for the merge commit." } }, "required": [ "enabled_by", "merge_method", "commit_title", "commit_message" ] }, "draft": { "description": "Indicates whether or not the pull request is a draft.", "type": "boolean", "examples": [ false ] } }, "required": [ "_links", "assignee", "labels", "base", "body", "closed_at", "comments_url", "commits_url", "created_at", "diff_url", "head", "html_url", "id", "node_id", "issue_url", "merge_commit_sha", "merged_at", "milestone", "number", "patch_url", "review_comment_url", "review_comments_url", "statuses_url", "state", "locked", "title", "updated_at", "url", "user", "author_association", "auto_merge" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "reviews": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", "title": "List reviews for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "The list of reviews returns in chronological order.
", "example": [ { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Here is the body for the review.", "state": "APPROVED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" } ], "schema": { "type": "array", "items": { "title": "Pull Request Review", "description": "Pull Request Reviews are reviews on pull requests.", "type": "object", "properties": { "id": { "description": "Unique identifier of the review", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The text of the review.", "type": "string", "examples": [ "This looks great." ] }, "state": { "type": "string", "examples": [ "CHANGES_REQUESTED" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" ] }, "pull_request_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/12" ] }, "_links": { "type": "object", "properties": { "html": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "html", "pull_request" ] }, "submitted_at": { "type": "string", "format": "date-time" }, "commit_id": { "description": "A commit SHA for the review.", "type": "string", "examples": [ "54bb654c9e6025347f57900a4a5c2313a96b8035" ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] } }, "required": [ "id", "node_id", "user", "body", "state", "commit_id", "html_url", "pull_request_url", "_links", "author_association" ] } } } } ], "previews": [], "descriptionHTML": "The list of reviews returns in chronological order.
", "statusCodes": [ { "httpStatusCode": "200", "description": "The list of reviews returns in chronological order.
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", "title": "Create a review for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "commit_id", "in": "body", "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.
Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.
The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
Use the following table to specify the location, destination, and contents of the draft review comment.
", "childParamsGroups": [ { "type": "string", "name": "path", "description": "The relative path to the file that necessitates a review comment.
", "isRequired": true }, { "type": "integer", "name": "position", "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.
" }, { "type": "string", "name": "body", "description": "Text of the review comment.
", "isRequired": true }, { "type": "integer", "name": "line", "description": "" }, { "type": "string", "name": "side", "description": "" }, { "type": "integer", "name": "start_line", "description": "" }, { "type": "string", "name": "start_side", "description": "" } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "body": "This is close to perfect! Please address the suggested inline change.", "event": "REQUEST_CHANGES", "comments": [ { "path": "file.md", "position": 6, "body": "Please add more information here, and fix this typo." } ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "This is close to perfect! Please address the suggested inline change.", "state": "CHANGES_REQUESTED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" }, "schema": { "title": "Pull Request Review", "description": "Pull Request Reviews are reviews on pull requests.", "type": "object", "properties": { "id": { "description": "Unique identifier of the review", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The text of the review.", "type": "string", "examples": [ "This looks great." ] }, "state": { "type": "string", "examples": [ "CHANGES_REQUESTED" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" ] }, "pull_request_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/12" ] }, "_links": { "type": "object", "properties": { "html": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "html", "pull_request" ] }, "submitted_at": { "type": "string", "format": "date-time" }, "commit_id": { "description": "A commit SHA for the review.", "type": "string", "examples": [ "54bb654c9e6025347f57900a4a5c2313a96b8035" ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] } }, "required": [ "id", "node_id", "user", "body", "state", "commit_id", "html_url", "pull_request_url", "_links", "author_association" ] } } } ], "previews": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "title": "Get a review for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "review_id", "description": "The unique identifier of the review.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER", "review_id": "REVIEW_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Here is the body for the review.", "state": "APPROVED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" }, "schema": { "title": "Pull Request Review", "description": "Pull Request Reviews are reviews on pull requests.", "type": "object", "properties": { "id": { "description": "Unique identifier of the review", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The text of the review.", "type": "string", "examples": [ "This looks great." ] }, "state": { "type": "string", "examples": [ "CHANGES_REQUESTED" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" ] }, "pull_request_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/12" ] }, "_links": { "type": "object", "properties": { "html": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "html", "pull_request" ] }, "submitted_at": { "type": "string", "format": "date-time" }, "commit_id": { "description": "A commit SHA for the review.", "type": "string", "examples": [ "54bb654c9e6025347f57900a4a5c2313a96b8035" ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] } }, "required": [ "id", "node_id", "user", "body", "state", "commit_id", "html_url", "pull_request_url", "_links", "author_association" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "title": "Update a review for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "review_id", "description": "The unique identifier of the review.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The body text of the pull request review.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "This is close to perfect! Please address the suggested inline change. And add more about this." }, "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER", "review_id": "REVIEW_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "This is close to perfect! Please address the suggested inline change. And add more about this.", "state": "CHANGES_REQUESTED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" }, "schema": { "title": "Pull Request Review", "description": "Pull Request Reviews are reviews on pull requests.", "type": "object", "properties": { "id": { "description": "Unique identifier of the review", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The text of the review.", "type": "string", "examples": [ "This looks great." ] }, "state": { "type": "string", "examples": [ "CHANGES_REQUESTED" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" ] }, "pull_request_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/12" ] }, "_links": { "type": "object", "properties": { "html": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "html", "pull_request" ] }, "submitted_at": { "type": "string", "format": "date-time" }, "commit_id": { "description": "A commit SHA for the review.", "type": "string", "examples": [ "54bb654c9e6025347f57900a4a5c2313a96b8035" ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] } }, "required": [ "id", "node_id", "user", "body", "state", "commit_id", "html_url", "pull_request_url", "_links", "author_association" ] } } } ], "previews": [], "descriptionHTML": "Update the review summary comment with new text.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "title": "Delete a pending review for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "review_id", "description": "The unique identifier of the review.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER", "review_id": "REVIEW_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "This is close to perfect! Please address the suggested inline change.", "state": "CHANGES_REQUESTED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" }, "schema": { "title": "Pull Request Review", "description": "Pull Request Reviews are reviews on pull requests.", "type": "object", "properties": { "id": { "description": "Unique identifier of the review", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The text of the review.", "type": "string", "examples": [ "This looks great." ] }, "state": { "type": "string", "examples": [ "CHANGES_REQUESTED" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" ] }, "pull_request_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/12" ] }, "_links": { "type": "object", "properties": { "html": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "html", "pull_request" ] }, "submitted_at": { "type": "string", "format": "date-time" }, "commit_id": { "description": "A commit SHA for the review.", "type": "string", "examples": [ "54bb654c9e6025347f57900a4a5c2313a96b8035" ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] } }, "required": [ "id", "node_id", "user", "body", "state", "commit_id", "html_url", "pull_request_url", "_links", "author_association" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", "title": "List comments for a pull request review", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "review_id", "description": "The unique identifier of the review.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER", "review_id": "REVIEW_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } } } ], "schema": { "type": "array", "items": { "title": "Legacy Review Comment", "description": "Legacy Review Comment", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" ] }, "pull_request_review_id": { "type": [ "integer", "null" ], "examples": [ 42 ] }, "id": { "type": "integer", "examples": [ 10 ] }, "node_id": { "type": "string", "examples": [ "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" ] }, "diff_hunk": { "type": "string", "examples": [ "@@ -16,33 +16,40 @@ public class Connection : IConnection..." ] }, "path": { "type": "string", "examples": [ "file1.txt" ] }, "position": { "type": [ "integer", "null" ], "examples": [ 1 ] }, "original_position": { "type": "integer", "examples": [ 4 ] }, "commit_id": { "type": "string", "examples": [ "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "original_commit_id": { "type": "string", "examples": [ "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840" ] }, "in_reply_to_id": { "type": "integer", "examples": [ 8 ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "type": "string", "examples": [ "Great stuff" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-14T16:00:49Z" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" ] }, "pull_request_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1" ] }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "_links": { "type": "object", "properties": { "self": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "html": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "pull_request": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "self", "html", "pull_request" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "side": { "description": "The side of the first line of the range for a multi-line comment.", "enum": [ "LEFT", "RIGHT" ], "default": "RIGHT", "type": "string" }, "start_side": { "type": [ "string", "null" ], "description": "The side of the first line of the range for a multi-line comment.", "enum": [ "LEFT", "RIGHT", null ], "default": "RIGHT" }, "line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "original_line": { "description": "The original line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer", "examples": [ 2 ] }, "start_line": { "description": "The first line of the range for a multi-line comment.", "type": [ "integer", "null" ], "examples": [ 2 ] }, "original_start_line": { "description": "The original first line of the range for a multi-line comment.", "type": [ "integer", "null" ], "examples": [ 2 ] } }, "required": [ "id", "node_id", "url", "body", "diff_hunk", "path", "position", "original_position", "commit_id", "original_commit_id", "user", "pull_request_review_id", "html_url", "pull_request_url", "_links", "author_association", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "List comments for a specific pull request review.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", "title": "Dismiss a review for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "review_id", "description": "The unique identifier of the review.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "message", "in": "body", "description": "The message for the pull request review dismissal
", "isRequired": true }, { "type": "string", "name": "event", "in": "body", "description": "", "enum": [ "DISMISS" ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "You are dismissed", "event": "DISMISS" }, "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER", "review_id": "REVIEW_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Here is the body for the review.", "state": "DISMISSED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" }, "schema": { "title": "Pull Request Review", "description": "Pull Request Reviews are reviews on pull requests.", "type": "object", "properties": { "id": { "description": "Unique identifier of the review", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The text of the review.", "type": "string", "examples": [ "This looks great." ] }, "state": { "type": "string", "examples": [ "CHANGES_REQUESTED" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" ] }, "pull_request_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/12" ] }, "_links": { "type": "object", "properties": { "html": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "html", "pull_request" ] }, "submitted_at": { "type": "string", "format": "date-time" }, "commit_id": { "description": "A commit SHA for the review.", "type": "string", "examples": [ "54bb654c9e6025347f57900a4a5c2313a96b8035" ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] } }, "required": [ "id", "node_id", "user", "body", "state", "commit_id", "html_url", "pull_request_url", "_links", "author_association" ] } } } ], "previews": [], "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", "title": "Submit a review for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pull_number", "description": "The number that identifies the pull request.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "review_id", "description": "The unique identifier of the review.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The body text of the pull request review
" }, { "type": "string", "name": "event", "in": "body", "description": "The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.
Response
", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Here is the body for the review.", "state": "APPROVED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" }, "schema": { "title": "Pull Request Review", "description": "Pull Request Reviews are reviews on pull requests.", "type": "object", "properties": { "id": { "description": "Unique identifier of the review", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The text of the review.", "type": "string", "examples": [ "This looks great." ] }, "state": { "type": "string", "examples": [ "CHANGES_REQUESTED" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" ] }, "pull_request_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/12" ] }, "_links": { "type": "object", "properties": { "html": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "html", "pull_request" ] }, "submitted_at": { "type": "string", "format": "date-time" }, "commit_id": { "description": "A commit SHA for the review.", "type": "string", "examples": [ "54bb654c9e6025347f57900a4a5c2313a96b8035" ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] } }, "required": [ "id", "node_id", "user", "body", "state", "commit_id", "html_url", "pull_request_url", "_links", "author_association" ] } } } ], "previews": [], "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ] }, "rate-limit": { "rate-limit": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/rate_limit", "title": "Get rate limit status for the authenticated user", "category": "rate-limit", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "resources": { "core": { "limit": 5000, "remaining": 4999, "reset": 1372700873, "used": 1 }, "search": { "limit": 30, "remaining": 18, "reset": 1372697452, "used": 12 }, "graphql": { "limit": 5000, "remaining": 4993, "reset": 1372700389, "used": 7 }, "integration_manifest": { "limit": 5000, "remaining": 4999, "reset": 1551806725, "used": 1 }, "code_scanning_upload": { "limit": 500, "remaining": 499, "reset": 1551806725, "used": 1 } }, "rate": { "limit": 5000, "remaining": 4999, "reset": 1372700873, "used": 1 } }, "schema": { "title": "Rate Limit Overview", "description": "Rate Limit Overview", "type": "object", "properties": { "resources": { "type": "object", "properties": { "core": { "title": "Rate Limit", "type": "object", "properties": { "limit": { "type": "integer" }, "remaining": { "type": "integer" }, "reset": { "type": "integer" }, "used": { "type": "integer" } }, "required": [ "limit", "remaining", "reset", "used" ] }, "graphql": { "title": "Rate Limit", "type": "object", "properties": { "limit": { "type": "integer" }, "remaining": { "type": "integer" }, "reset": { "type": "integer" }, "used": { "type": "integer" } }, "required": [ "limit", "remaining", "reset", "used" ] }, "search": { "title": "Rate Limit", "type": "object", "properties": { "limit": { "type": "integer" }, "remaining": { "type": "integer" }, "reset": { "type": "integer" }, "used": { "type": "integer" } }, "required": [ "limit", "remaining", "reset", "used" ] }, "source_import": { "title": "Rate Limit", "type": "object", "properties": { "limit": { "type": "integer" }, "remaining": { "type": "integer" }, "reset": { "type": "integer" }, "used": { "type": "integer" } }, "required": [ "limit", "remaining", "reset", "used" ] }, "integration_manifest": { "title": "Rate Limit", "type": "object", "properties": { "limit": { "type": "integer" }, "remaining": { "type": "integer" }, "reset": { "type": "integer" }, "used": { "type": "integer" } }, "required": [ "limit", "remaining", "reset", "used" ] }, "code_scanning_upload": { "title": "Rate Limit", "type": "object", "properties": { "limit": { "type": "integer" }, "remaining": { "type": "integer" }, "reset": { "type": "integer" }, "used": { "type": "integer" } }, "required": [ "limit", "remaining", "reset", "used" ] }, "actions_runner_registration": { "title": "Rate Limit", "type": "object", "properties": { "limit": { "type": "integer" }, "remaining": { "type": "integer" }, "reset": { "type": "integer" }, "used": { "type": "integer" } }, "required": [ "limit", "remaining", "reset", "used" ] }, "scim": { "title": "Rate Limit", "type": "object", "properties": { "limit": { "type": "integer" }, "remaining": { "type": "integer" }, "reset": { "type": "integer" }, "used": { "type": "integer" } }, "required": [ "limit", "remaining", "reset", "used" ] }, "dependency_snapshots": { "title": "Rate Limit", "type": "object", "properties": { "limit": { "type": "integer" }, "remaining": { "type": "integer" }, "reset": { "type": "integer" }, "used": { "type": "integer" } }, "required": [ "limit", "remaining", "reset", "used" ] } }, "required": [ "core", "search" ] }, "rate": { "title": "Rate Limit", "type": "object", "properties": { "limit": { "type": "integer" }, "remaining": { "type": "integer" }, "reset": { "type": "integer" }, "used": { "type": "integer" } }, "required": [ "limit", "remaining", "reset", "used" ] } }, "required": [ "rate", "resources" ] } } } ], "previews": [], "descriptionHTML": "Note: Accessing this endpoint does not count against your REST API rate limit.
\nNote: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "rate-limit" } ] }, "reactions": { "reactions": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "title": "List reactions for a team discussion comment", "category": "reactions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "comment_number", "description": "The number that identifies the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content", "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ], "schema": { "type": "array", "items": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OK
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "title": "Create reaction for a team discussion comment", "category": "reactions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "comment_number", "description": "The number that identifies the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "content", "in": "body", "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response when the reaction type has already been added to this team discussion comment
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } ], "previews": [], "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Response when the reaction type has already been added to this team discussion comment
" }, { "httpStatusCode": "201", "description": "Created
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", "title": "Delete team discussion comment reaction", "category": "reactions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "comment_number", "description": "The number that identifies the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "reaction_id", "description": "The unique identifier of the reaction.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "title": "List reactions for a team discussion", "category": "reactions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content", "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ], "schema": { "type": "array", "items": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OK
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "title": "Create reaction for a team discussion", "category": "reactions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "content", "in": "body", "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } ], "previews": [], "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OK
" }, { "httpStatusCode": "201", "description": "Created
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", "title": "Delete team discussion reaction", "category": "reactions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "reaction_id", "description": "The unique identifier of the reaction.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "title": "List reactions for a commit comment", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content", "description": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ], "schema": { "type": "array", "items": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "title": "Create reaction for a commit comment", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "content", "in": "body", "description": "The reaction type to add to the commit comment.
", "isRequired": true, "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Reaction exists
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Reaction created
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } ], "previews": [], "descriptionHTML": "Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Reaction exists
" }, { "httpStatusCode": "201", "description": "Reaction created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", "title": "Delete a commit comment reaction", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "reaction_id", "description": "The unique identifier of the reaction.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "title": "List reactions for an issue comment", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content", "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ], "schema": { "type": "array", "items": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "List the reactions to an issue comment.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "title": "Create reaction for an issue comment", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "content", "in": "body", "description": "The reaction type to add to the issue comment.
", "isRequired": true, "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Reaction exists
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Reaction created
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } ], "previews": [], "descriptionHTML": "Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Reaction exists
" }, { "httpStatusCode": "201", "description": "Reaction created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", "title": "Delete an issue comment reaction", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "reaction_id", "description": "The unique identifier of the reaction.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", "title": "List reactions for an issue", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content", "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ], "schema": { "type": "array", "items": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "List the reactions to an issue.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", "title": "Create reaction for an issue", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "content", "in": "body", "description": "The reaction type to add to the issue.
", "isRequired": true, "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } ], "previews": [], "descriptionHTML": "Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
OK
" }, { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", "title": "Delete an issue reaction", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issue_number", "description": "The number that identifies the issue.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "reaction_id", "description": "The unique identifier of the reaction.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "title": "List reactions for a pull request review comment", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content", "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ], "schema": { "type": "array", "items": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "title": "Create reaction for a pull request review comment", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "content", "in": "body", "description": "The reaction type to add to the pull request review comment.
", "isRequired": true, "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Reaction exists
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Reaction created
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } ], "previews": [], "descriptionHTML": "Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Reaction exists
" }, { "httpStatusCode": "201", "description": "Reaction created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", "title": "Delete a pull request comment reaction", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "reaction_id", "description": "The unique identifier of the reaction.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions", "title": "List reactions for a release", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "release_id", "description": "The unique identifier of the release.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content", "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "laugh", "heart", "hooray", "rocket", "eyes" ] } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ], "schema": { "type": "array", "items": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "List the reactions to a release.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions", "title": "Create reaction for a release", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "release_id", "description": "The unique identifier of the release.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "content", "in": "body", "description": "The reaction type to add to the release.
", "isRequired": true, "enum": [ "+1", "laugh", "heart", "hooray", "rocket", "eyes" ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Reaction exists
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Reaction created
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } ], "previews": [], "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Reaction exists
" }, { "httpStatusCode": "201", "description": "Reaction created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}", "title": "Delete a release reaction", "category": "reactions", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "release_id", "description": "The unique identifier of the release.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "reaction_id", "description": "The unique identifier of the reaction.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", "title": "List reactions for a team discussion comment (Legacy)", "category": "reactions", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "comment_number", "description": "The number that identifies the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content", "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ], "schema": { "type": "array", "items": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
OK
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", "title": "Create reaction for a team discussion comment (Legacy)", "category": "reactions", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "comment_number", "description": "The number that identifies the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "content", "in": "body", "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Created
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", "title": "List reactions for a team discussion (Legacy)", "category": "reactions", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content", "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ], "schema": { "type": "array", "items": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
OK
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", "title": "Create reaction for a team discussion (Legacy)", "category": "reactions", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "content", "in": "body", "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" }, "schema": { "title": "Reaction", "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDg6UmVhY3Rpb24x" ] }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "content": { "description": "The reaction to use", "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "examples": [ "heart" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", "user", "content", "created_at" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Created
" } ], "subcategory": "reactions" } ] }, "releases": { "releases": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", "id": 1, "node_id": "MDc6UmVsZWFzZTE=", "tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0", "body": "Description of the release", "draft": false, "prerelease": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assets": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } ] } ], "schema": { "type": "array", "items": { "title": "Release", "description": "A release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "assets_url": { "type": "string", "format": "uri" }, "upload_url": { "type": "string" }, "tarball_url": { "type": [ "string", "null" ], "format": "uri" }, "zipball_url": { "type": [ "string", "null" ], "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "tag_name": { "description": "The name of the tag.", "type": "string", "examples": [ "v1.0.0" ] }, "target_commitish": { "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string", "examples": [ "master" ] }, "name": { "type": [ "string", "null" ] }, "body": { "type": [ "string", "null" ] }, "draft": { "description": "true to create a draft (unpublished) release, false to create a published one.", "type": "boolean", "examples": [ false ] }, "prerelease": { "description": "Whether to identify the release as a prerelease or a full release.", "type": "boolean", "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time" }, "published_at": { "type": [ "string", "null" ], "format": "date-time" }, "author": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "browser_download_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "description": "The file name of the asset.", "type": "string", "examples": [ "Team Environment" ] }, "label": { "type": [ "string", "null" ] }, "state": { "description": "State of the release asset.", "type": "string", "enum": [ "uploaded", "open" ] }, "content_type": { "type": "string" }, "size": { "type": "integer" }, "download_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "id", "name", "content_type", "size", "state", "url", "node_id", "download_count", "label", "uploader", "browser_download_url", "created_at", "updated_at" ] } }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "mentions_count": { "type": "integer" }, "discussion_url": { "description": "The URL of the release discussion.", "type": "string", "format": "uri" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assets_url", "upload_url", "tarball_url", "zipball_url", "created_at", "published_at", "draft", "id", "node_id", "author", "html_url", "name", "prerelease", "tag_name", "target_commitish", "assets", "url" ] } } } } ], "previews": [], "descriptionHTML": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.
\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "tag_name", "in": "body", "description": "The name of the tag.
", "isRequired": true }, { "type": "string", "name": "target_commitish", "in": "body", "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
The name of the release.
" }, { "type": "string", "name": "body", "in": "body", "description": "Text describing the contents of the tag.
" }, { "type": "boolean", "name": "draft", "in": "body", "description": "true to create a draft (unpublished) release, false to create a published one.
true to identify the release as a prerelease. false to identify the release as a full release.
If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"Managing categories for discussions in your repository.\"
" }, { "type": "boolean", "name": "generate_release_notes", "in": "body", "description": "Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.
Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", "id": 1, "node_id": "MDc6UmVsZWFzZTE=", "tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0", "body": "Description of the release", "draft": false, "prerelease": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assets": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } ] }, "schema": { "title": "Release", "description": "A release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "assets_url": { "type": "string", "format": "uri" }, "upload_url": { "type": "string" }, "tarball_url": { "type": [ "string", "null" ], "format": "uri" }, "zipball_url": { "type": [ "string", "null" ], "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "tag_name": { "description": "The name of the tag.", "type": "string", "examples": [ "v1.0.0" ] }, "target_commitish": { "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string", "examples": [ "master" ] }, "name": { "type": [ "string", "null" ] }, "body": { "type": [ "string", "null" ] }, "draft": { "description": "true to create a draft (unpublished) release, false to create a published one.", "type": "boolean", "examples": [ false ] }, "prerelease": { "description": "Whether to identify the release as a prerelease or a full release.", "type": "boolean", "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time" }, "published_at": { "type": [ "string", "null" ], "format": "date-time" }, "author": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "browser_download_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "description": "The file name of the asset.", "type": "string", "examples": [ "Team Environment" ] }, "label": { "type": [ "string", "null" ] }, "state": { "description": "State of the release asset.", "type": "string", "enum": [ "uploaded", "open" ] }, "content_type": { "type": "string" }, "size": { "type": "integer" }, "download_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "id", "name", "content_type", "size", "state", "url", "node_id", "download_count", "label", "uploader", "browser_download_url", "created_at", "updated_at" ] } }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "mentions_count": { "type": "integer" }, "discussion_url": { "description": "The URL of the release discussion.", "type": "string", "format": "uri" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assets_url", "upload_url", "tarball_url", "zipball_url", "created_at", "published_at", "draft", "id", "node_id", "author", "html_url", "name", "prerelease", "tag_name", "target_commitish", "assets", "url" ] } } } ], "previews": [], "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Not Found if the discussion category name is invalid
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/generate-notes", "title": "Generate release notes content for a release", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "tag_name", "in": "body", "description": "The tag name for the release. This can be an existing tag or a new one.
", "isRequired": true }, { "type": "string", "name": "target_commitish", "in": "body", "description": "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.
" }, { "type": "string", "name": "previous_tag_name", "in": "body", "description": "The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.
" }, { "type": "string", "name": "configuration_file_path", "in": "body", "description": "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", "target_commitish": "main", "previous_tag_name": "v0.9.2", "configuration_file_path": ".github/custom_release_config.yml" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Name and body of generated release notes
", "example": { "name": "Release v1.0.0 is now available!", "body": "##Changes in Release v1.0.0 ... ##Contributors @monalisa" }, "schema": { "title": "Generated Release Notes Content", "description": "Generated name and body describing a release", "type": "object", "properties": { "name": { "description": "The generated name of the release", "type": "string", "examples": [ "Release v1.0.0 is now available!" ] }, "body": { "description": "The generated body describing the contents of the release supporting markdown formatting", "type": "string" } }, "required": [ "name", "body" ] } } } ], "previews": [], "descriptionHTML": "Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", "statusCodes": [ { "httpStatusCode": "200", "description": "Name and body of generated release notes
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", "id": 1, "node_id": "MDc6UmVsZWFzZTE=", "tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0", "body": "Description of the release", "draft": false, "prerelease": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assets": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } ] }, "schema": { "title": "Release", "description": "A release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "assets_url": { "type": "string", "format": "uri" }, "upload_url": { "type": "string" }, "tarball_url": { "type": [ "string", "null" ], "format": "uri" }, "zipball_url": { "type": [ "string", "null" ], "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "tag_name": { "description": "The name of the tag.", "type": "string", "examples": [ "v1.0.0" ] }, "target_commitish": { "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string", "examples": [ "master" ] }, "name": { "type": [ "string", "null" ] }, "body": { "type": [ "string", "null" ] }, "draft": { "description": "true to create a draft (unpublished) release, false to create a published one.", "type": "boolean", "examples": [ false ] }, "prerelease": { "description": "Whether to identify the release as a prerelease or a full release.", "type": "boolean", "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time" }, "published_at": { "type": [ "string", "null" ], "format": "date-time" }, "author": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "browser_download_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "description": "The file name of the asset.", "type": "string", "examples": [ "Team Environment" ] }, "label": { "type": [ "string", "null" ] }, "state": { "description": "State of the release asset.", "type": "string", "enum": [ "uploaded", "open" ] }, "content_type": { "type": "string" }, "size": { "type": "integer" }, "download_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "id", "name", "content_type", "size", "state", "url", "node_id", "download_count", "label", "uploader", "browser_download_url", "created_at", "updated_at" ] } }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "mentions_count": { "type": "integer" }, "discussion_url": { "description": "The URL of the release discussion.", "type": "string", "format": "uri" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assets_url", "upload_url", "tarball_url", "zipball_url", "created_at", "published_at", "draft", "id", "node_id", "author", "html_url", "name", "prerelease", "tag_name", "target_commitish", "assets", "url" ] } } } ], "previews": [], "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tag", "description": "tag parameter
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "tag": "TAG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", "id": 1, "node_id": "MDc6UmVsZWFzZTE=", "tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0", "body": "Description of the release", "draft": false, "prerelease": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assets": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } ] }, "schema": { "title": "Release", "description": "A release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "assets_url": { "type": "string", "format": "uri" }, "upload_url": { "type": "string" }, "tarball_url": { "type": [ "string", "null" ], "format": "uri" }, "zipball_url": { "type": [ "string", "null" ], "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "tag_name": { "description": "The name of the tag.", "type": "string", "examples": [ "v1.0.0" ] }, "target_commitish": { "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string", "examples": [ "master" ] }, "name": { "type": [ "string", "null" ] }, "body": { "type": [ "string", "null" ] }, "draft": { "description": "true to create a draft (unpublished) release, false to create a published one.", "type": "boolean", "examples": [ false ] }, "prerelease": { "description": "Whether to identify the release as a prerelease or a full release.", "type": "boolean", "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time" }, "published_at": { "type": [ "string", "null" ], "format": "date-time" }, "author": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "browser_download_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "description": "The file name of the asset.", "type": "string", "examples": [ "Team Environment" ] }, "label": { "type": [ "string", "null" ] }, "state": { "description": "State of the release asset.", "type": "string", "enum": [ "uploaded", "open" ] }, "content_type": { "type": "string" }, "size": { "type": "integer" }, "download_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "id", "name", "content_type", "size", "state", "url", "node_id", "download_count", "label", "uploader", "browser_download_url", "created_at", "updated_at" ] } }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "mentions_count": { "type": "integer" }, "discussion_url": { "description": "The URL of the release discussion.", "type": "string", "format": "uri" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assets_url", "upload_url", "tarball_url", "zipball_url", "created_at", "published_at", "draft", "id", "node_id", "author", "html_url", "name", "prerelease", "tag_name", "target_commitish", "assets", "url" ] } } } ], "previews": [], "descriptionHTML": "Get a published release with the specified tag.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "release_id", "description": "The unique identifier of the release.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "release_id", "description": "The unique identifier of the release.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "tag_name", "in": "body", "description": "The name of the tag.
" }, { "type": "string", "name": "target_commitish", "in": "body", "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
The name of the release.
" }, { "type": "string", "name": "body", "in": "body", "description": "Text describing the contents of the tag.
" }, { "type": "boolean", "name": "draft", "in": "body", "description": "true makes the release a draft, and false publishes the release.
true to identify the release as a prerelease, false to identify the release as a full release.
If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"Managing categories for discussions in your repository.\"
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0", "body": "Description of the release", "draft": false, "prerelease": false }, "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", "id": 1, "node_id": "MDc6UmVsZWFzZTE=", "tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0", "body": "Description of the release", "draft": false, "prerelease": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assets": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } ] }, "schema": { "title": "Release", "description": "A release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "assets_url": { "type": "string", "format": "uri" }, "upload_url": { "type": "string" }, "tarball_url": { "type": [ "string", "null" ], "format": "uri" }, "zipball_url": { "type": [ "string", "null" ], "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "tag_name": { "description": "The name of the tag.", "type": "string", "examples": [ "v1.0.0" ] }, "target_commitish": { "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string", "examples": [ "master" ] }, "name": { "type": [ "string", "null" ] }, "body": { "type": [ "string", "null" ] }, "draft": { "description": "true to create a draft (unpublished) release, false to create a published one.", "type": "boolean", "examples": [ false ] }, "prerelease": { "description": "Whether to identify the release as a prerelease or a full release.", "type": "boolean", "examples": [ false ] }, "created_at": { "type": "string", "format": "date-time" }, "published_at": { "type": [ "string", "null" ], "format": "date-time" }, "author": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "browser_download_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "description": "The file name of the asset.", "type": "string", "examples": [ "Team Environment" ] }, "label": { "type": [ "string", "null" ] }, "state": { "description": "State of the release asset.", "type": "string", "enum": [ "uploaded", "open" ] }, "content_type": { "type": "string" }, "size": { "type": "integer" }, "download_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "id", "name", "content_type", "size", "state", "url", "node_id", "download_count", "label", "uploader", "browser_download_url", "created_at", "updated_at" ] } }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "mentions_count": { "type": "integer" }, "discussion_url": { "description": "The URL of the release discussion.", "type": "string", "format": "uri" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assets_url", "upload_url", "tarball_url", "zipball_url", "created_at", "published_at", "draft", "id", "node_id", "author", "html_url", "name", "prerelease", "tag_name", "target_commitish", "assets", "url" ] } } } ], "previews": [], "descriptionHTML": "Users with push access to the repository can edit a release.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Not Found if the discussion category name is invalid
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "release_id", "description": "The unique identifier of the release.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Users with push access to the repository can delete a release.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ], "assets": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", "title": "Get a release asset", "category": "releases", "subcategory": "assets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "asset_id", "description": "The unique identifier of the asset.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "asset_id": "ASSET_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, "schema": { "title": "Release Asset", "description": "Data related to a release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "browser_download_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "description": "The file name of the asset.", "type": "string", "examples": [ "Team Environment" ] }, "label": { "type": [ "string", "null" ] }, "state": { "description": "State of the release asset.", "type": "string", "enum": [ "uploaded", "open" ] }, "content_type": { "type": "string" }, "size": { "type": "integer" }, "download_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "id", "name", "content_type", "size", "state", "url", "node_id", "download_count", "label", "uploader", "browser_download_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.
OK
" }, { "httpStatusCode": "302", "description": "Found
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", "title": "Update a release asset", "category": "releases", "subcategory": "assets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "asset_id", "description": "The unique identifier of the asset.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The file name of the asset.
" }, { "type": "string", "name": "label", "in": "body", "description": "An alternate short description of the asset. Used in place of the filename.
" }, { "type": "string", "name": "state", "in": "body", "description": "" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "foo-1.0.0-osx.zip", "label": "Mac binary" }, "parameters": { "owner": "OWNER", "repo": "REPO", "asset_id": "ASSET_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, "schema": { "title": "Release Asset", "description": "Data related to a release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "browser_download_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "description": "The file name of the asset.", "type": "string", "examples": [ "Team Environment" ] }, "label": { "type": [ "string", "null" ] }, "state": { "description": "State of the release asset.", "type": "string", "enum": [ "uploaded", "open" ] }, "content_type": { "type": "string" }, "size": { "type": "integer" }, "download_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "id", "name", "content_type", "size", "state", "url", "node_id", "download_count", "label", "uploader", "browser_download_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Users with push access to the repository can edit a release asset.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", "title": "Delete a release asset", "category": "releases", "subcategory": "assets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "asset_id", "description": "The unique identifier of the asset.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "asset_id": "ASSET_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", "title": "List release assets", "category": "releases", "subcategory": "assets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "release_id", "description": "The unique identifier of the release.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } ], "schema": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "browser_download_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "description": "The file name of the asset.", "type": "string", "examples": [ "Team Environment" ] }, "label": { "type": [ "string", "null" ] }, "state": { "description": "State of the release asset.", "type": "string", "enum": [ "uploaded", "open" ] }, "content_type": { "type": "string" }, "size": { "type": "integer" }, "download_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "id", "name", "content_type", "size", "state", "url", "node_id", "download_count", "label", "uploader", "browser_download_url", "created_at", "updated_at" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://uploads.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", "title": "Upload a release asset", "category": "releases", "subcategory": "assets", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "release_id", "description": "The unique identifier of the release.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" }, "description": "" }, { "name": "label", "in": "query", "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "*/*", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response for successful upload
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }, "schema": { "title": "Release Asset", "description": "Data related to a release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "browser_download_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "description": "The file name of the asset.", "type": "string", "examples": [ "Team Environment" ] }, "label": { "type": [ "string", "null" ] }, "state": { "description": "State of the release asset.", "type": "string", "enum": [ "uploaded", "open" ] }, "content_type": { "type": "string" }, "size": { "type": "integer" }, "download_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "id", "name", "content_type", "size", "state", "url", "node_id", "download_count", "label", "uploader", "browser_download_url", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\n- \n
- GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"List assets for a release\"\nendpoint lists the renamed filenames. For more information and help, contact GitHub Support. \n
- If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. \n
Response for successful upload
" }, { "httpStatusCode": "422", "description": "Response if you upload an asset with the same filename as another uploaded asset
" } ] } ] }, "repos": { "repos": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/repos", "title": "List organization repositories", "category": "repos", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "description": "Specifies the types of repositories you want returned. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal. However, the internal value is not yet supported when a GitHub App calls this API with an installation access token.
The property to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated", "pushed", "full_name" ], "default": "created" } }, { "name": "direction", "description": "The order to sort by. Default: asc when using full_name, otherwise desc.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": null } ], "schema": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists repositories for the specified organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/repos", "title": "Create an organization repository", "category": "repos", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "description", "in": "body", "description": "A short description of the repository.
" }, { "type": "string", "name": "homepage", "in": "body", "description": "A URL with more information about the repository.
" }, { "type": "boolean", "name": "private", "in": "body", "description": "Whether the repository is private.
" }, { "type": "string", "name": "visibility", "in": "body", "description": "Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
Either true to enable issues for this repository or false to disable them.
Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.
Either true to enable the wiki for this repository or false to disable it.
Either true to make this repo available as a template repository or false to prevent it.
The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.
" }, { "type": "boolean", "name": "auto_init", "in": "body", "description": "Pass true to create an initial commit with empty README.
Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".
" }, { "type": "string", "name": "license_template", "in": "body", "description": "Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".
Either true to allow squash-merging pull requests, or false to prevent squash-merging.
Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.
Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
Either true to allow auto-merge on pull requests, or false to disallow auto-merge.
Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property has been deprecated. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\n- \n
PR_TITLE- default to the pull request's title. \nCOMMIT_OR_PR_TITLE- default to the commit's title (if only one commit) or the pull request's title (when more than one commit). \n
The default value for a squash merge commit message:
\n- \n
PR_BODY- default to the pull request's body. \nCOMMIT_MESSAGES- default to the branch's commit messages. \nBLANK- default to a blank commit message. \n
The default value for a merge commit title.
\n- \n
PR_TITLE- default to the pull request's title. \nMERGE_MESSAGE- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). \n
The default value for a merge commit message.
\n- \n
PR_TITLE- default to the pull request's title. \nPR_BODY- default to the pull request's body. \nBLANK- default to a blank commit message. \n
Response
", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "organization": null, "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "schema": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\n- \n
public_reposcope orreposcope to create a public repository. Note: For GitHub AE, usereposcope to create an internal repository. \nreposcope to create a private repository \n
Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}", "title": "Get a repository", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Default response
", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "forks": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "open_issues": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "pull": true, "push": false, "admin": false }, "allow_rebase_merge": true, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "node_id": "MDc6TGljZW5zZW1pdA==" }, "organization": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "Organization", "site_admin": false }, "parent": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 }, "source": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } }, "schema": { "title": "Full Repository", "description": "Full Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" }, "examples": [ "octocat", "atom", "electron", "API" ] }, "has_issues": { "type": "boolean", "examples": [ true ] }, "has_projects": { "type": "boolean", "examples": [ true ] }, "has_wiki": { "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean", "examples": [ true ] }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "type": "string", "examples": [ "public" ] }, "pushed_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "allow_rebase_merge": { "type": "boolean", "examples": [ true ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": [ "string", "null" ] }, "allow_squash_merge": { "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "type": "boolean", "examples": [ false ] }, "allow_merge_commit": { "type": "boolean", "examples": [ true ] }, "allow_update_branch": { "type": "boolean", "examples": [ true ] }, "use_squash_pr_title_as_default": { "type": "boolean", "examples": [ false ] }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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).", "examples": [ "PR_TITLE" ] }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", "examples": [ "PR_BODY" ] }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "examples": [ "PR_TITLE" ] }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "examples": [ "PR_BODY" ] }, "allow_forking": { "type": "boolean", "examples": [ true ] }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] }, "subscribers_count": { "type": "integer", "examples": [ 42 ] }, "network_count": { "type": "integer", "examples": [ 0 ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "parent": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "source": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "forks": { "type": "integer" }, "master_branch": { "type": "string" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "anonymous_access_enabled": { "description": "Whether anonymous git access is allowed.", "default": true, "type": "boolean" }, "code_of_conduct": { "title": "Code Of Conduct Simple", "description": "Code of Conduct Simple", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/github/docs/community/code_of_conduct" ] }, "key": { "type": "string", "examples": [ "citizen_code_of_conduct" ] }, "name": { "type": "string", "examples": [ "Citizen Code of Conduct" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" ] } }, "required": [ "url", "key", "name", "html_url" ] }, "security_and_analysis": { "type": [ "object", "null" ], "properties": { "advanced_security": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_push_protection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at", "network_count", "subscribers_count" ] } } } ], "previews": [], "descriptionHTML": "The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
OK
" }, { "httpStatusCode": "301", "description": "Moved permanently
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}", "title": "Update a repository", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name of the repository.
" }, { "type": "string", "name": "description", "in": "body", "description": "A short description of the repository.
" }, { "type": "string", "name": "homepage", "in": "body", "description": "A URL with more information about the repository.
" }, { "type": "boolean", "name": "private", "in": "body", "description": "Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.
Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal.\"
Specify which security and analysis features to enable or disable for the repository.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nFor example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.
You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.
Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"
Can be enabled or disabled.
Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"
Can be enabled or disabled.
Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"
Can be enabled or disabled.
Either true to enable issues for this repository or false to disable them.
Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.
Either true to enable the wiki for this repository or false to disable it.
Either true to make this repo available as a template repository or false to prevent it.
Updates the default branch for this repository.
" }, { "type": "boolean", "name": "allow_squash_merge", "in": "body", "description": "Either true to allow squash-merging pull requests, or false to prevent squash-merging.
Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.
Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
Either true to allow auto-merge on pull requests, or false to disallow auto-merge.
Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property has been deprecated. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
\n- \n
PR_TITLE- default to the pull request's title. \nCOMMIT_OR_PR_TITLE- default to the commit's title (if only one commit) or the pull request's title (when more than one commit). \n
The default value for a squash merge commit message:
\n- \n
PR_BODY- default to the pull request's body. \nCOMMIT_MESSAGES- default to the branch's commit messages. \nBLANK- default to a blank commit message. \n
The default value for a merge commit title.
\n- \n
PR_TITLE- default to the pull request's title. \nMERGE_MESSAGE- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). \n
The default value for a merge commit message.
\n- \n
PR_TITLE- default to the pull request's title. \nPR_BODY- default to the pull request's body. \nBLANK- default to a blank commit message. \n
true to archive this repository. Note: You cannot unarchive repositories through the API.
Either true to allow private forks, or false to prevent private forks.
Either true to require contributors to sign off on web-based commits, or false to not require contributors to sign off on web-based commits.
Response
", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "language": null, "forks_count": 9, "forks": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "open_issues": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "pull": true, "push": false, "admin": false }, "allow_rebase_merge": true, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "allow_forking": true, "web_commit_signoff_required": false, "subscribers_count": 42, "network_count": 0, "organization": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "Organization", "site_admin": false }, "parent": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 }, "source": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } }, "schema": { "title": "Full Repository", "description": "Full Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" }, "examples": [ "octocat", "atom", "electron", "API" ] }, "has_issues": { "type": "boolean", "examples": [ true ] }, "has_projects": { "type": "boolean", "examples": [ true ] }, "has_wiki": { "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean", "examples": [ true ] }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "type": "string", "examples": [ "public" ] }, "pushed_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "allow_rebase_merge": { "type": "boolean", "examples": [ true ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": [ "string", "null" ] }, "allow_squash_merge": { "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "type": "boolean", "examples": [ false ] }, "allow_merge_commit": { "type": "boolean", "examples": [ true ] }, "allow_update_branch": { "type": "boolean", "examples": [ true ] }, "use_squash_pr_title_as_default": { "type": "boolean", "examples": [ false ] }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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).", "examples": [ "PR_TITLE" ] }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", "examples": [ "PR_BODY" ] }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "examples": [ "PR_TITLE" ] }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "examples": [ "PR_BODY" ] }, "allow_forking": { "type": "boolean", "examples": [ true ] }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] }, "subscribers_count": { "type": "integer", "examples": [ 42 ] }, "network_count": { "type": "integer", "examples": [ 0 ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "parent": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "source": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "forks": { "type": "integer" }, "master_branch": { "type": "string" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "anonymous_access_enabled": { "description": "Whether anonymous git access is allowed.", "default": true, "type": "boolean" }, "code_of_conduct": { "title": "Code Of Conduct Simple", "description": "Code of Conduct Simple", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/github/docs/community/code_of_conduct" ] }, "key": { "type": "string", "examples": [ "citizen_code_of_conduct" ] }, "name": { "type": "string", "examples": [ "Citizen Code of Conduct" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" ] } }, "required": [ "url", "key", "name", "html_url" ] }, "security_and_analysis": { "type": [ "object", "null" ], "properties": { "advanced_security": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_push_protection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at", "network_count", "subscribers_count" ] } } } ], "previews": [], "descriptionHTML": "Note: To edit a repository's topics, use the Replace all repository topics endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "307", "description": "Temporary Redirect
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}", "title": "Delete a repository", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.
If an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.
No Content
" }, { "httpStatusCode": "307", "description": "Temporary Redirect
" }, { "httpStatusCode": "403", "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/automated-security-fixes", "title": "Enable automated security fixes", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"Configuring automated security fixes\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/automated-security-fixes", "title": "Disable automated security fixes", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"Configuring automated security fixes\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codeowners/errors", "title": "List CODEOWNERS errors", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ref", "description": "A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. main)
Response
", "example": { "errors": [ { "line": 3, "column": 1, "kind": "Invalid pattern", "source": "***/*.rb @monalisa", "suggestion": "Did you mean `**/*.rb`?", "message": "Invalid pattern on line 3: Did you mean `**/*.rb`?\n\n ***/*.rb @monalisa\n ^", "path": ".github/CODEOWNERS" }, { "line": 7, "column": 7, "kind": "Invalid owner", "source": "*.txt docs@", "suggestion": null, "message": "Invalid owner on line 7:\n\n *.txt docs@\n ^", "path": ".github/CODEOWNERS" } ] }, "schema": { "title": "CODEOWNERS errors", "description": "A list of errors found in a repo's CODEOWNERS file", "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "line": { "description": "The line number where this errors occurs.", "type": "integer", "examples": [ 7 ] }, "column": { "description": "The column number where this errors occurs.", "type": "integer", "examples": [ 3 ] }, "source": { "description": "The contents of the line where the error occurs.", "type": "string", "examples": [ "* user" ] }, "kind": { "description": "The type of error.", "type": "string", "examples": [ "Invalid owner" ] }, "suggestion": { "description": "Suggested action to fix the error. This will usually be `null`, but is provided for some common errors.", "type": [ "string", "null" ], "examples": [ "The pattern `/` will never match anything, did you mean `*` instead?" ] }, "message": { "description": "A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting).", "type": "string", "examples": [ "Invalid owner on line 7:\n\n * user\n ^" ] }, "path": { "description": "The path of the file where the error occured.", "type": "string", "examples": [ ".github/CODEOWNERS" ] } }, "required": [ "line", "column", "kind", "message", "path" ] } } }, "required": [ "errors" ] } } } ], "previews": [], "descriptionHTML": "List any syntax errors that are detected in the CODEOWNERS\nfile.
\nFor more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/contributors", "title": "List repository contributors", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "anon", "description": "Set to 1 or true to include anonymous contributors in results.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "response-if-repository-contains-content", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "if repository contains content
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false, "contributions": 32 } ], "schema": { "type": "array", "items": { "title": "Contributor", "description": "Contributor", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "contributions": { "type": "integer" }, "email": { "type": "string" }, "name": { "type": "string" } }, "required": [ "contributions", "type" ] } } } } ], "previews": [], "descriptionHTML": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.
\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
", "statusCodes": [ { "httpStatusCode": "200", "description": "if repository contains content
" }, { "httpStatusCode": "204", "description": "Response if repository is empty
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/dispatches", "title": "Create a repository dispatch event", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "event_type", "in": "body", "description": "A custom webhook event name. Must be 100 characters or fewer.
", "isRequired": true }, { "type": "object", "name": "client_payload", "in": "body", "description": "JSON payload with extra information about the webhook event that your action or workflow may use.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "event_type": "on-demand-test", "client_payload": { "unit": false, "integration": true } }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see \"RepositoryDispatchEvent.\"
The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow.
This endpoint requires write access to the repository by providing either:
\n- \n
- Personal access tokens with
reposcope. For more information, see \"Creating a personal access token for the command line\" in the GitHub Help documentation. \n - GitHub Apps with both
metadata:readandcontents:read&writepermissions. \n
This input example shows how you can use the client_payload as a test to debug your workflow.
No Content
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages", "title": "List repository languages", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "C": 78769, "Python": 7769 }, "schema": { "title": "Language", "description": "Language", "type": "object", "additionalProperties": { "type": "integer" } } } } ], "previews": [], "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/tags", "title": "List repository tags", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "name": "v0.1", "commit": { "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" }, "zipball_url": "https://github.com/octocat/Hello-World/zipball/v0.1", "tarball_url": "https://github.com/octocat/Hello-World/tarball/v0.1", "node_id": "MDQ6VXNlcjE=" } ], "schema": { "type": "array", "items": { "title": "Tag", "description": "Tag", "type": "object", "properties": { "name": { "type": "string", "examples": [ "v0.1" ] }, "commit": { "type": "object", "properties": { "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "sha", "url" ] }, "zipball_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/zipball/v0.1" ] }, "tarball_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/tarball/v0.1" ] }, "node_id": { "type": "string" } }, "required": [ "name", "node_id", "commit", "zipball_url", "tarball_url" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/teams", "title": "List repository teams", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "schema": { "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/topics", "title": "Get all repository topics", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "names": [ "octocat", "atom", "electron", "api" ] }, "schema": { "title": "Topic", "description": "A topic aggregates entities that are related to a subject.", "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" } } }, "required": [ "names" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/topics", "title": "Replace all repository topics", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of strings", "name": "names", "in": "body", "description": "An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.
Response
", "example": { "names": [ "octocat", "atom", "electron", "api" ] }, "schema": { "title": "Topic", "description": "A topic aggregates entities that are related to a subject.", "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" } } }, "required": [ "names" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/transfer", "title": "Transfer a repository", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "new_owner", "in": "body", "description": "The username or organization name the repository will be transferred to.
", "isRequired": true }, { "type": "array of integers", "name": "team_ids", "in": "body", "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_owner": "github", "team_ids": [ 12, 345 ] }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response
", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "allow_forking": true, "subscribers_count": 42, "network_count": 0 } }, "schema": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } ], "previews": [], "descriptionHTML": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.
Accepted
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", "title": "Check if vulnerability alerts are enabled for a repository", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response if repository is enabled with vulnerability alerts
" } } ], "previews": [], "descriptionHTML": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "Response if repository is enabled with vulnerability alerts
" }, { "httpStatusCode": "404", "description": "Not Found if repository is not enabled with vulnerability alerts
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", "title": "Enable vulnerability alerts", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", "title": "Disable vulnerability alerts", "category": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{template_owner}/{template_repo}/generate", "title": "Create a repository using a template", "category": "repos", "parameters": [ { "name": "template_owner", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" }, { "name": "template_repo", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [ { "type": "string", "name": "owner", "in": "body", "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.
" }, { "type": "string", "name": "name", "in": "body", "description": "The name of the new repository.
", "isRequired": true }, { "type": "string", "name": "description", "in": "body", "description": "A short description of the new repository.
" }, { "type": "boolean", "name": "include_all_branches", "in": "body", "description": "Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.
Either true to create a new private repository or false to create a new public one.
Response
", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "forks": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "open_issues": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "allow_auto_merge": false, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" } }, "schema": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.
OAuth scope requirements
\nWhen using OAuth, authorizations must include:
\n- \n
public_reposcope orreposcope to create a public repository. Note: For GitHub AE, usereposcope to create an internal repository. \nreposcope to create a private repository \n
Created
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repositories", "title": "List public repositories", "category": "repos", "parameters": [ { "name": "since", "description": "A repository ID. Only return repositories with an ID greater than this ID.
", "in": "query", "required": false, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } ], "schema": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists all public repositories in the order that they were created.
\nNote:
\n- \n
- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. \n
- Pagination is powered exclusively by the
sinceparameter. Use the Link header to get the URL for the next page of repositories. \n
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/repos", "title": "List repositories for the authenticated user", "category": "repos", "parameters": [ { "name": "visibility", "description": "Limit results to repositories with the specified visibility.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "public", "private" ], "default": "all" } }, { "name": "affiliation", "description": "Comma-separated list of values. Can include:
\n* owner: Repositories that are owned by the authenticated user.
\n* collaborator: Repositories that the user has been added to as a collaborator.
\n* organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
Limit results to repositories of the specified type. Will cause a 422 error if used in the same request as visibility or affiliation.
The property to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated", "pushed", "full_name" ], "default": "full_name" } }, { "name": "direction", "description": "The order to sort by. Default: asc when using full_name, otherwise desc.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "since", "description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Default response
", "example": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ], "schema": { "type": "array", "items": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access.
The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/repos", "title": "Create a repository for the authenticated user", "category": "repos", "parameters": [], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name of the repository.
", "isRequired": true }, { "type": "string", "name": "description", "in": "body", "description": "A short description of the repository.
" }, { "type": "string", "name": "homepage", "in": "body", "description": "A URL with more information about the repository.
" }, { "type": "boolean", "name": "private", "in": "body", "description": "Whether the repository is private.
" }, { "type": "boolean", "name": "has_issues", "in": "body", "description": "Whether issues are enabled.
", "default": true }, { "type": "boolean", "name": "has_projects", "in": "body", "description": "Whether projects are enabled.
", "default": true }, { "type": "boolean", "name": "has_wiki", "in": "body", "description": "Whether the wiki is enabled.
", "default": true }, { "type": "integer", "name": "team_id", "in": "body", "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.
" }, { "type": "boolean", "name": "auto_init", "in": "body", "description": "Whether the repository is initialized with a minimal README.
" }, { "type": "string", "name": "gitignore_template", "in": "body", "description": "The desired language or platform to apply to the .gitignore.
" }, { "type": "string", "name": "license_template", "in": "body", "description": "The license keyword of the open source license for this repository.
" }, { "type": "boolean", "name": "allow_squash_merge", "in": "body", "description": "Whether to allow squash merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_merge_commit", "in": "body", "description": "Whether to allow merge commits for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_rebase_merge", "in": "body", "description": "Whether to allow rebase merges for pull requests.
", "default": true }, { "type": "boolean", "name": "allow_auto_merge", "in": "body", "description": "Whether to allow Auto-merge to be used on pull requests.
" }, { "type": "boolean", "name": "delete_branch_on_merge", "in": "body", "description": "Whether to delete head branches when pull requests are merged
" }, { "type": "string", "name": "squash_merge_commit_title", "in": "body", "description": "The default value for a squash merge commit title:
\n- \n
PR_TITLE- default to the pull request's title. \nCOMMIT_OR_PR_TITLE- default to the commit's title (if only one commit) or the pull request's title (when more than one commit). \n
The default value for a squash merge commit message:
\n- \n
PR_BODY- default to the pull request's body. \nCOMMIT_MESSAGES- default to the branch's commit messages. \nBLANK- default to a blank commit message. \n
The default value for a merge commit title.
\n- \n
PR_TITLE- default to the pull request's title. \nMERGE_MESSAGE- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). \n
The default value for a merge commit message.
\n- \n
PR_TITLE- default to the pull request's title. \nPR_BODY- default to the pull request's body. \nBLANK- default to a blank commit message. \n
Whether downloads are enabled.
", "default": true }, { "type": "boolean", "name": "is_template", "in": "body", "description": "Whether this repository acts as a template that can be used to generate new repositories.
" } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "organization": null, "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "schema": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Creates a new repository for the authenticated user.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\n- \n
public_reposcope orreposcope to create a public repository. Note: For GitHub AE, usereposcope to create an internal repository. \nreposcope to create a private repository. \n
Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/repos", "title": "List repositories for a user", "category": "repos", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "description": "Limit results to repositories of the specified type.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "owner", "member" ], "default": "owner" } }, { "name": "sort", "description": "The property to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated", "pushed", "full_name" ], "default": "full_name" } }, { "name": "direction", "description": "The order to sort by. Default: asc when using full_name, otherwise desc.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": null } ], "schema": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "repos" } ], "autolinks": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/autolinks", "title": "List all autolinks of a repository", "category": "repos", "subcategory": "autolinks", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=This returns a list of autolinks configured for the given repository.
\nInformation about autolinks are only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/autolinks", "title": "Create an autolink reference for a repository", "category": "repos", "subcategory": "autolinks", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "key_prefix", "in": "body", "description": "This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.
", "isRequired": true }, { "type": "string", "name": "url_template", "in": "body", "description": "The URL must contain <num> for the reference number. <num> matches different characters depending on the value of is_alphanumeric.
Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.
response
", "example": { "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=Users with admin access to the repository can create an autolink.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}", "title": "Get an autolink reference of a repository", "category": "repos", "subcategory": "autolinks", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "autolink_id", "description": "The unique identifier of the autolink.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "autolink_id": "AUTOLINK_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=This returns a single autolink reference by ID that was configured for the given repository.
\nInformation about autolinks are only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}", "title": "Delete an autolink reference from a repository", "category": "repos", "subcategory": "autolinks", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "autolink_id", "description": "The unique identifier of the autolink.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "autolink_id": "AUTOLINK_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "This deletes a single autolink reference by ID that was configured for the given repository.
\nInformation about autolinks are only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "contents": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", "title": "Get repository content", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "path", "description": "path parameter
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true }, { "name": "ref", "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
Response if content is a file
", "example": { "type": "file", "encoding": "base64", "size": 5362, "name": "README.md", "path": "README.md", "content": "encoded content ...", "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", "_links": { "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" } }, "schema": { "oneOf": [ { "title": "Content Directory", "description": "A list of directory items", "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dir", "file", "submodule", "symlink" ] }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "content": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url" ] } }, { "title": "Content File", "description": "Content File", "type": "object", "properties": { "type": { "type": "string", "enum": [ "file" ] }, "encoding": { "type": "string" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "content": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] }, "target": { "type": "string", "examples": [ "\"actual/actual.md\"" ] }, "submodule_git_url": { "type": "string", "examples": [ "\"git://example.com/defunkt/dotjs.git\"" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "content", "encoding" ] }, { "title": "Symlink Content", "description": "An object describing a symlink", "type": "object", "properties": { "type": { "type": "string", "enum": [ "symlink" ] }, "target": { "type": "string" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "target" ] }, { "title": "Submodule Content", "description": "An object describing a submodule", "type": "object", "properties": { "type": { "type": "string", "enum": [ "submodule" ] }, "submodule_git_url": { "type": "string", "format": "uri" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "submodule_git_url" ] } ] } } }, { "key": "response-if-content-is-a-directory", "request": { "description": "Example 2: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "path": "PATH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if content is a directory
", "example": [ { "type": "file", "size": 625, "name": "octokit.rb", "path": "lib/octokit.rb", "sha": "fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb", "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", "html_url": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb", "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb", "_links": { "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb", "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", "html": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb" } }, { "type": "dir", "size": 0, "name": "octokit", "path": "lib/octokit", "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit", "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", "html_url": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit", "download_url": null, "_links": { "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit", "git": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", "html": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit" } } ], "schema": { "oneOf": [ { "title": "Content Directory", "description": "A list of directory items", "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dir", "file", "submodule", "symlink" ] }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "content": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url" ] } }, { "title": "Content File", "description": "Content File", "type": "object", "properties": { "type": { "type": "string", "enum": [ "file" ] }, "encoding": { "type": "string" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "content": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] }, "target": { "type": "string", "examples": [ "\"actual/actual.md\"" ] }, "submodule_git_url": { "type": "string", "examples": [ "\"git://example.com/defunkt/dotjs.git\"" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "content", "encoding" ] }, { "title": "Symlink Content", "description": "An object describing a symlink", "type": "object", "properties": { "type": { "type": "string", "enum": [ "symlink" ] }, "target": { "type": "string" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "target" ] }, { "title": "Submodule Content", "description": "An object describing a submodule", "type": "object", "properties": { "type": { "type": "string", "enum": [ "submodule" ] }, "submodule_git_url": { "type": "string", "format": "uri" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "submodule_git_url" ] } ] } } }, { "key": "response-if-content-is-a-symlink", "request": { "description": "Example 3: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "path": "PATH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if content is a symlink
", "example": { "type": "symlink", "target": "/path/to/symlink/target", "size": 23, "name": "some-symlink", "path": "bin/some-symlink", "sha": "452a98979c88e093d682cab404a3ec82babebb48", "url": "https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink", "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48", "html_url": "https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink", "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink", "_links": { "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48", "self": "https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink", "html": "https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink" } }, "schema": { "oneOf": [ { "title": "Content Directory", "description": "A list of directory items", "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dir", "file", "submodule", "symlink" ] }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "content": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url" ] } }, { "title": "Content File", "description": "Content File", "type": "object", "properties": { "type": { "type": "string", "enum": [ "file" ] }, "encoding": { "type": "string" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "content": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] }, "target": { "type": "string", "examples": [ "\"actual/actual.md\"" ] }, "submodule_git_url": { "type": "string", "examples": [ "\"git://example.com/defunkt/dotjs.git\"" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "content", "encoding" ] }, { "title": "Symlink Content", "description": "An object describing a symlink", "type": "object", "properties": { "type": { "type": "string", "enum": [ "symlink" ] }, "target": { "type": "string" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "target" ] }, { "title": "Submodule Content", "description": "An object describing a submodule", "type": "object", "properties": { "type": { "type": "string", "enum": [ "submodule" ] }, "submodule_git_url": { "type": "string", "format": "uri" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "submodule_git_url" ] } ] } } }, { "key": "response-if-content-is-a-submodule", "request": { "description": "Example 4: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "path": "PATH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if content is a submodule
", "example": { "type": "submodule", "submodule_git_url": "git://github.com/jquery/qunit.git", "size": 0, "name": "qunit", "path": "test/qunit", "sha": "6ca3721222109997540bd6d9ccd396902e0ad2f9", "url": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master", "git_url": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9", "html_url": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9", "download_url": null, "_links": { "git": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9", "self": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master", "html": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9" } }, "schema": { "oneOf": [ { "title": "Content Directory", "description": "A list of directory items", "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dir", "file", "submodule", "symlink" ] }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "content": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url" ] } }, { "title": "Content File", "description": "Content File", "type": "object", "properties": { "type": { "type": "string", "enum": [ "file" ] }, "encoding": { "type": "string" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "content": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] }, "target": { "type": "string", "examples": [ "\"actual/actual.md\"" ] }, "submodule_git_url": { "type": "string", "examples": [ "\"git://example.com/defunkt/dotjs.git\"" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "content", "encoding" ] }, { "title": "Symlink Content", "description": "An object describing a symlink", "type": "object", "properties": { "type": { "type": "string", "enum": [ "symlink" ] }, "target": { "type": "string" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "target" ] }, { "title": "Submodule Content", "description": "An object describing a submodule", "type": "object", "properties": { "type": { "type": "string", "enum": [ "submodule" ] }, "submodule_git_url": { "type": "string", "format": "uri" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "submodule_git_url" ] } ] } } } ], "previews": [], "descriptionHTML": "Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\n- \n
- To get a repository's contents recursively, you can recursively get the tree. \n
- This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI. \n
- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. \n
Size limits
\nIf the requested file's size is:
\n- \n
- 1 MB or smaller: All features of this endpoint are supported. \n
- Between 1-100 MB: Only the
raworobjectcustom media types are supported. Both will work as normal, except that when using theobjectmedia type, thecontentfield will be an empty string and theencodingfield will be\"none\". To get the contents of these larger files, use therawmedia type. \n - Greater than 100 MB: This endpoint is not supported. \n
If the content is a directory
\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the content is a symlink
\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule
\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
OK
" }, { "httpStatusCode": "302", "description": "Found
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/contents/{path}", "title": "Create or update file contents", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "path", "description": "path parameter
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "string", "name": "message", "in": "body", "description": "The commit message.
", "isRequired": true }, { "type": "string", "name": "content", "in": "body", "description": "The new file content, using Base64 encoding.
", "isRequired": true }, { "type": "string", "name": "sha", "in": "body", "description": "Required if you are updating a file. The blob SHA of the file being replaced.
" }, { "type": "string", "name": "branch", "in": "body", "description": "The branch name. Default: the repository’s default branch (usually master)
The person that committed the file. Default: the authenticated user.
", "childParamsGroups": [ { "type": "string", "name": "name", "description": "The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
The author of the file. Default: The committer or the authenticated user if you omit committer.
The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
Response
", "example": { "content": { "name": "hello.txt", "path": "notes/hello.txt", "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3", "size": 9, "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt", "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3", "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt", "type": "file", "_links": { "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3", "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt" } }, "commit": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd", "author": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "committer": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "message": "my commit message", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", "sha": "691272480426f78a0138979dd3ce63b77f706feb" }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5", "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" } ], "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } } }, "schema": { "title": "File Commit", "description": "File Commit", "type": "object", "required": [ "content", "commit" ], "properties": { "content": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "git_url": { "type": "string" }, "download_url": { "type": "string" }, "type": { "type": "string" }, "_links": { "type": "object", "properties": { "self": { "type": "string" }, "git": { "type": "string" }, "html": { "type": "string" } } } } }, "commit": { "type": "object", "properties": { "sha": { "type": "string" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "author": { "type": "object", "properties": { "date": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "committer": { "type": "object", "properties": { "date": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "message": { "type": "string" }, "tree": { "type": "object", "properties": { "url": { "type": "string" }, "sha": { "type": "string" } } }, "parents": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "html_url": { "type": "string" }, "sha": { "type": "string" } } } }, "verification": { "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "signature": { "type": [ "string", "null" ] }, "payload": { "type": [ "string", "null" ] } } } } } } } } }, { "key": "example-for-updating-a-file", "request": { "contentType": "application/json", "description": "Example for updating a file", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "a new commit message", "committer": { "name": "Monalisa Octocat", "email": "octocat@github.com" }, "content": "bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz", "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3" }, "parameters": { "owner": "OWNER", "repo": "REPO", "path": "PATH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "content": { "name": "hello.txt", "path": "notes/hello.txt", "sha": "a56507ed892d05a37c6d6128c260937ea4d287bd", "size": 9, "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt", "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd", "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt", "type": "file", "_links": { "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd", "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt" } }, "commit": { "sha": "18a43cd8e1e3a79c786e3d808a73d23b6d212b16", "node_id": "MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16", "html_url": "https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16", "author": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "committer": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "message": "my commit message", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f", "sha": "9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f" }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6", "html_url": "https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6", "sha": "da5a433788da5c255edad7979b328b67d79f53f6" } ], "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } } }, "schema": { "title": "File Commit", "description": "File Commit", "type": "object", "required": [ "content", "commit" ], "properties": { "content": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "git_url": { "type": "string" }, "download_url": { "type": "string" }, "type": { "type": "string" }, "_links": { "type": "object", "properties": { "self": { "type": "string" }, "git": { "type": "string" }, "html": { "type": "string" } } } } }, "commit": { "type": "object", "properties": { "sha": { "type": "string" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "author": { "type": "object", "properties": { "date": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "committer": { "type": "object", "properties": { "date": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "message": { "type": "string" }, "tree": { "type": "object", "properties": { "url": { "type": "string" }, "sha": { "type": "string" } } }, "parents": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "html_url": { "type": "string" }, "sha": { "type": "string" } } } }, "verification": { "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "signature": { "type": [ "string", "null" ] }, "payload": { "type": [ "string", "null" ] } } } } } } } } } ], "previews": [], "descriptionHTML": "Creates a new file or replaces an existing file in a repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/contents/{path}", "title": "Delete a file", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "path", "description": "path parameter
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "bodyParameters": [ { "type": "string", "name": "message", "in": "body", "description": "The commit message.
", "isRequired": true }, { "type": "string", "name": "sha", "in": "body", "description": "The blob SHA of the file being deleted.
", "isRequired": true }, { "type": "string", "name": "branch", "in": "body", "description": "The branch name. Default: the repository’s default branch (usually master)
object containing information about the committer.
", "childParamsGroups": [ { "type": "string", "name": "name", "description": "The name of the author (or committer) of the commit
" }, { "type": "string", "name": "email", "description": "The email of the author (or committer) of the commit
" } ] }, { "type": "object", "name": "author", "in": "body", "description": "object containing information about the author.
", "childParamsGroups": [ { "type": "string", "name": "name", "description": "The name of the author (or committer) of the commit
" }, { "type": "string", "name": "email", "description": "The email of the author (or committer) of the commit
" } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", "committer": { "name": "Monalisa Octocat", "email": "octocat@github.com" }, "sha": "329688480d39049927147c162b9d2deaf885005f" }, "parameters": { "owner": "OWNER", "repo": "REPO", "path": "PATH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "content": null, "commit": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd", "author": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "committer": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "message": "my commit message", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", "sha": "691272480426f78a0138979dd3ce63b77f706feb" }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5", "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" } ], "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } } }, "schema": { "title": "File Commit", "description": "File Commit", "type": "object", "required": [ "content", "commit" ], "properties": { "content": { "type": [ "object", "null" ], "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "git_url": { "type": "string" }, "download_url": { "type": "string" }, "type": { "type": "string" }, "_links": { "type": "object", "properties": { "self": { "type": "string" }, "git": { "type": "string" }, "html": { "type": "string" } } } } }, "commit": { "type": "object", "properties": { "sha": { "type": "string" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "author": { "type": "object", "properties": { "date": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "committer": { "type": "object", "properties": { "date": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "message": { "type": "string" }, "tree": { "type": "object", "properties": { "url": { "type": "string" }, "sha": { "type": "string" } } }, "parents": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "html_url": { "type": "string" }, "sha": { "type": "string" } } } }, "verification": { "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "signature": { "type": [ "string", "null" ] }, "payload": { "type": [ "string", "null" ] } } } } } } } } } ], "previews": [], "descriptionHTML": "Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/readme", "title": "Get a repository README", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ref", "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
Response
", "example": { "type": "file", "encoding": "base64", "size": 5362, "name": "README.md", "path": "README.md", "content": "encoded content ...", "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", "_links": { "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" } }, "schema": { "title": "Content File", "description": "Content File", "type": "object", "properties": { "type": { "type": "string", "enum": [ "file" ] }, "encoding": { "type": "string" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "content": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] }, "target": { "type": "string", "examples": [ "\"actual/actual.md\"" ] }, "submodule_git_url": { "type": "string", "examples": [ "\"git://example.com/defunkt/dotjs.git\"" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "content", "encoding" ] } } } ], "previews": [], "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/readme/{dir}", "title": "Get a repository README for a directory", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dir", "description": "The alternate path to look for a README file
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true }, { "name": "ref", "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
Response
", "example": { "type": "file", "encoding": "base64", "size": 5362, "name": "README.md", "path": "README.md", "content": "encoded content ...", "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", "_links": { "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" } }, "schema": { "title": "Content File", "description": "Content File", "type": "object", "properties": { "type": { "type": "string", "enum": [ "file" ] }, "encoding": { "type": "string" }, "size": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "content": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "download_url": { "type": [ "string", "null" ], "format": "uri" }, "_links": { "type": "object", "properties": { "git": { "type": [ "string", "null" ], "format": "uri" }, "html": { "type": [ "string", "null" ], "format": "uri" }, "self": { "type": "string", "format": "uri" } }, "required": [ "git", "html", "self" ] }, "target": { "type": "string", "examples": [ "\"actual/actual.md\"" ] }, "submodule_git_url": { "type": "string", "examples": [ "\"git://example.com/defunkt/dotjs.git\"" ] } }, "required": [ "_links", "git_url", "html_url", "download_url", "name", "path", "sha", "size", "type", "url", "content", "encoding" ] } } } ], "previews": [], "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/tarball/{ref}", "title": "Download a repository archive (tar)", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ref", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "302", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmaster) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.\nNote: For private repositories, these links are temporary and expire after five minutes.
Found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/zipball/{ref}", "title": "Download a repository archive (zip)", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ref", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "302", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmaster) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
", "statusCodes": [ { "httpStatusCode": "302", "description": "Found
" } ] } ], "forks": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/forks", "title": "List forks", "category": "repos", "subcategory": "forks", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sort", "description": "The sort order. Can be either newest, oldest, or stargazers.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": true, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "delete_branch_on_merge": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "node_id": "MDc6TGljZW5zZW1pdA==" } } ], "schema": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/forks", "title": "Create a fork", "category": "repos", "subcategory": "forks", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "organization", "in": "body", "description": "Optional parameter to specify the organization name if forking into an organization.
" }, { "type": "string", "name": "name", "in": "body", "description": "When forking from an existing repository, a new name for the fork.
" }, { "type": "boolean", "name": "default_branch_only", "in": "body", "description": "When forking from an existing repository, fork with only the default branch.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response
", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "language": null, "forks_count": 9, "forks": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "open_issues": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "pull": true, "push": false, "admin": false }, "allow_rebase_merge": true, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "allow_forking": true, "web_commit_signoff_required": false, "subscribers_count": 42, "network_count": 0, "organization": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "Organization", "site_admin": false }, "parent": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 }, "source": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } }, "schema": { "title": "Full Repository", "description": "Full Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" }, "examples": [ "octocat", "atom", "electron", "API" ] }, "has_issues": { "type": "boolean", "examples": [ true ] }, "has_projects": { "type": "boolean", "examples": [ true ] }, "has_wiki": { "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean", "examples": [ true ] }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "type": "string", "examples": [ "public" ] }, "pushed_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "allow_rebase_merge": { "type": "boolean", "examples": [ true ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": [ "string", "null" ] }, "allow_squash_merge": { "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "type": "boolean", "examples": [ false ] }, "allow_merge_commit": { "type": "boolean", "examples": [ true ] }, "allow_update_branch": { "type": "boolean", "examples": [ true ] }, "use_squash_pr_title_as_default": { "type": "boolean", "examples": [ false ] }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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).", "examples": [ "PR_TITLE" ] }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", "examples": [ "PR_BODY" ] }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "examples": [ "PR_TITLE" ] }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "examples": [ "PR_BODY" ] }, "allow_forking": { "type": "boolean", "examples": [ true ] }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] }, "subscribers_count": { "type": "integer", "examples": [ 42 ] }, "network_count": { "type": "integer", "examples": [ 0 ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "parent": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "source": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "forks": { "type": "integer" }, "master_branch": { "type": "string" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "anonymous_access_enabled": { "description": "Whether anonymous git access is allowed.", "default": true, "type": "boolean" }, "code_of_conduct": { "title": "Code Of Conduct Simple", "description": "Code of Conduct Simple", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/github/docs/community/code_of_conduct" ] }, "key": { "type": "string", "examples": [ "citizen_code_of_conduct" ] }, "name": { "type": "string", "examples": [ "Citizen Code of Conduct" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" ] } }, "required": [ "url", "key", "name", "html_url" ] }, "security_and_analysis": { "type": [ "object", "null" ], "properties": { "advanced_security": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_push_protection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at", "network_count", "subscribers_count" ] } } } ], "previews": [], "descriptionHTML": "Create a fork for the authenticated user.
\nNote: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Support.
", "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "lfs": [ { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/lfs", "title": "Enable Git LFS for a repository", "category": "repos", "subcategory": "lfs", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "202", "description": "Accepted
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "403", "description": "We will return a 403 with one of the following messages:
\n- \n
- Git LFS support not enabled because Git LFS is globally disabled. \n
- Git LFS support not enabled because Git LFS is disabled for the root repository in the network. \n
- Git LFS support not enabled because Git LFS is disabled for
. \n
The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ], "tags": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/tags/protection", "title": "List tag protection states for a repository", "category": "repos", "subcategory": "tags", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 2, "pattern": "v1.*" } ], "schema": { "type": "array", "items": { "title": "Tag protection", "description": "Tag protection", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 2 ] }, "created_at": { "type": "string", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "examples": [ "2011-01-26T19:01:12Z" ] }, "enabled": { "type": "boolean", "examples": [ true ] }, "pattern": { "type": "string", "examples": [ "v1.*" ] } }, "required": [ "pattern" ] } } } } ], "previews": [], "descriptionHTML": "This returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/tags/protection", "title": "Create a tag protection state for a repository", "category": "repos", "subcategory": "tags", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "pattern", "in": "body", "description": "An optional glob pattern to match against when enforcing tag protection.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "pattern": "v1.*" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "enabled": true }, "schema": { "title": "Tag protection", "description": "Tag protection", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 2 ] }, "created_at": { "type": "string", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "examples": [ "2011-01-26T19:01:12Z" ] }, "enabled": { "type": "boolean", "examples": [ true ] }, "pattern": { "type": "string", "examples": [ "v1.*" ] } }, "required": [ "pattern" ] } } } ], "previews": [], "descriptionHTML": "This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}", "title": "Delete a tag protection state for a repository", "category": "repos", "subcategory": "tags", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tag_protection_id", "description": "The unique identifier of the tag protection.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "tag_protection_id": "TAG_PROTECTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ] }, "scim": { "scim": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/scim/v2/organizations/{org}/Users", "title": "List SCIM provisioned identities", "category": "scim", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startIndex", "description": "Used for pagination: the index of the first result to return.
", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "description": "Used for pagination: the number of results to return.
", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "filter", "description": "Filters results using the equals query parameter operator (eq). You can filter results that are equal to id, userName, emails, and external_id. For example, to search for an identity with the userName Octocat, you would use this query:
?filter=userName%20eq%20\\\"Octocat\\\".
To filter results for the identity with the email octocat@github.com, you would use this query:
?filter=emails%20eq%20\\\"octocat@github.com\\\".
Response with filter
", "example": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 1, "itemsPerPage": 1, "startIndex": 1, "Resources": [ { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "5fc0c238-1112-11e8-8e45-920c87bdbd75", "externalId": "00u1dhhb1fkIGP7RL1d8", "userName": "octocat@github.com", "displayName": "Mona Octocat", "name": { "givenName": "Mona", "familyName": "Octocat", "formatted": "Mona Octocat" }, "emails": [ { "value": "octocat@github.com", "primary": true } ], "active": true, "meta": { "resourceType": "User", "created": "2018-02-13T15:05:24.000-08:00", "lastModified": "2018-02-13T15:05:55.000-08:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/5fc0c238-1112-11e8-8e45-920c87bdbd75" } } ] }, "schema": { "title": "SCIM User List", "description": "SCIM User List", "type": "object", "properties": { "schemas": { "description": "SCIM schema used.", "type": "array", "minItems": 1, "items": { "type": "string", "examples": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ] } }, "totalResults": { "type": "integer", "examples": [ 3 ] }, "itemsPerPage": { "type": "integer", "examples": [ 10 ] }, "startIndex": { "type": "integer", "examples": [ 1 ] }, "Resources": { "type": "array", "items": { "title": "SCIM /Users", "description": "SCIM /Users provisioning endpoints", "type": "object", "properties": { "schemas": { "description": "SCIM schema used.", "type": "array", "minItems": 1, "items": { "type": "string", "examples": [ "urn:ietf:params:scim:schemas:core:2.0:User" ] } }, "id": { "description": "Unique identifier of an external identity", "type": "string", "examples": [ "1b78eada-9baa-11e6-9eb6-a431576d590e" ] }, "externalId": { "description": "The ID of the User.", "type": [ "string", "null" ], "examples": [ "a7b0f98395" ] }, "userName": { "description": "Configured by the admin. Could be an email, login, or username", "type": [ "string", "null" ], "examples": [ "someone@example.com" ] }, "displayName": { "description": "The name of the user, suitable for display to end-users", "type": [ "string", "null" ], "examples": [ "Jon Doe" ] }, "name": { "type": "object", "properties": { "givenName": { "type": [ "string", "null" ] }, "familyName": { "type": [ "string", "null" ] }, "formatted": { "type": [ "string", "null" ] } }, "required": [ "givenName", "familyName" ], "example": { "givenName": "Jane", "familyName": "User" } }, "emails": { "description": "user emails", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "value": { "type": "string" }, "primary": { "type": "boolean" } }, "required": [ "value" ] }, "examples": [ { "value": "someone@example.com", "primary": true }, { "value": "another@example.com", "primary": false } ] }, "active": { "description": "The active status of the User.", "type": "boolean", "examples": [ true ] }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string", "examples": [ "User" ] }, "created": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "lastModified": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "location": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/scim/v2/organizations/myorg-123abc55141bfd8f/Users/c42772b5-2029-11e9-8543-9264a97dec8d" ] } } }, "organization_id": { "description": "The ID of the organization.", "type": "integer" }, "operations": { "description": "Set of operations to be performed", "type": "array", "minItems": 1, "items": { "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "object" }, { "type": "array", "items": {} } ] } }, "required": [ "op" ], "type": "object" }, "examples": [ { "op": "replace", "value": { "active": false } } ] }, "groups": { "description": "associated groups", "type": "array", "items": { "properties": { "value": { "type": "string" }, "display": { "type": "string" } } } } }, "required": [ "id", "schemas", "externalId", "userName", "name", "emails", "active", "meta" ] } } }, "required": [ "schemas", "totalResults", "itemsPerPage", "startIndex", "Resources" ] } } }, { "key": "response-without-filter", "request": { "description": "Example 2: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/scim+json", "description": "Response without filter
", "example": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 2, "itemsPerPage": 2, "startIndex": 1, "Resources": [ { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Mona Octocat", "name": { "givenName": "Mona", "familyName": "Octocat", "formatted": "Mona Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } }, { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "77563764-eb6-24-0598234-958243", "externalId": "sdfoiausdofiua", "userName": "hubot@example.com", "displayName": "hu bot", "name": { "givenName": "hu", "familyName": "bot", "formatted": "hu bot" }, "emails": [ { "value": "hubot@example.com", "primary": true } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243" } } ] }, "schema": { "title": "SCIM User List", "description": "SCIM User List", "type": "object", "properties": { "schemas": { "description": "SCIM schema used.", "type": "array", "minItems": 1, "items": { "type": "string", "examples": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ] } }, "totalResults": { "type": "integer", "examples": [ 3 ] }, "itemsPerPage": { "type": "integer", "examples": [ 10 ] }, "startIndex": { "type": "integer", "examples": [ 1 ] }, "Resources": { "type": "array", "items": { "title": "SCIM /Users", "description": "SCIM /Users provisioning endpoints", "type": "object", "properties": { "schemas": { "description": "SCIM schema used.", "type": "array", "minItems": 1, "items": { "type": "string", "examples": [ "urn:ietf:params:scim:schemas:core:2.0:User" ] } }, "id": { "description": "Unique identifier of an external identity", "type": "string", "examples": [ "1b78eada-9baa-11e6-9eb6-a431576d590e" ] }, "externalId": { "description": "The ID of the User.", "type": [ "string", "null" ], "examples": [ "a7b0f98395" ] }, "userName": { "description": "Configured by the admin. Could be an email, login, or username", "type": [ "string", "null" ], "examples": [ "someone@example.com" ] }, "displayName": { "description": "The name of the user, suitable for display to end-users", "type": [ "string", "null" ], "examples": [ "Jon Doe" ] }, "name": { "type": "object", "properties": { "givenName": { "type": [ "string", "null" ] }, "familyName": { "type": [ "string", "null" ] }, "formatted": { "type": [ "string", "null" ] } }, "required": [ "givenName", "familyName" ], "example": { "givenName": "Jane", "familyName": "User" } }, "emails": { "description": "user emails", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "value": { "type": "string" }, "primary": { "type": "boolean" } }, "required": [ "value" ] }, "examples": [ { "value": "someone@example.com", "primary": true }, { "value": "another@example.com", "primary": false } ] }, "active": { "description": "The active status of the User.", "type": "boolean", "examples": [ true ] }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string", "examples": [ "User" ] }, "created": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "lastModified": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "location": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/scim/v2/organizations/myorg-123abc55141bfd8f/Users/c42772b5-2029-11e9-8543-9264a97dec8d" ] } } }, "organization_id": { "description": "The ID of the organization.", "type": "integer" }, "operations": { "description": "Set of operations to be performed", "type": "array", "minItems": 1, "items": { "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "object" }, { "type": "array", "items": {} } ] } }, "required": [ "op" ], "type": "object" }, "examples": [ { "op": "replace", "value": { "active": false } } ] }, "groups": { "description": "associated groups", "type": "array", "items": { "properties": { "value": { "type": "string" }, "display": { "type": "string" } } } } }, "required": [ "id", "schemas", "externalId", "userName", "name", "emails", "active", "meta" ] } } }, "required": [ "schemas", "totalResults", "itemsPerPage", "startIndex", "Resources" ] } } } ], "previews": [], "descriptionHTML": "Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the filter parameter, the resources for all matching provisions members are returned.
When a user with a SAML-provisioned external identity leaves (or is removed from) an organization, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member:
\n- \n
- When a user with a SCIM-provisioned external identity is removed from an organization, the account's metadata is preserved to allow the user to re-join the organization in the future. \n
- When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). \n
- When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. \n
The returned list of external identities can include an entry for a null user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:
- \n
- \n
The user is granted access by the IdP and is not a member of the GitHub organization.
\n \n - \n
The user attempts to access the GitHub organization and initiates the SAML SSO process, and is not currently signed in to their GitHub account.
\n \n - \n
After successfully authenticating with the SAML SSO IdP, the
\nnullexternal identity entry is created and the user is prompted to sign in to their GitHub account:- \n
- If the user signs in, their GitHub account is linked to this entry. \n
- If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity
nullentry remains in place. \n
\n
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "429", "description": "Too Many Requests
" } ], "subcategory": "scim" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/scim/v2/organizations/{org}/Users", "title": "Provision and invite a SCIM user", "category": "scim", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "userName", "in": "body", "description": "Configured by the admin. Could be an email, login, or username
", "isRequired": true }, { "type": "string", "name": "displayName", "in": "body", "description": "The name of the user, suitable for display to end-users
" }, { "type": "object", "name": "name", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "givenName", "description": "", "isRequired": true }, { "type": "string", "name": "familyName", "description": "", "isRequired": true }, { "type": "string", "name": "formatted", "description": "" } ] }, { "type": "array of objects", "name": "emails", "in": "body", "description": "user emails
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "value", "description": "", "isRequired": true }, { "type": "boolean", "name": "primary", "description": "" }, { "type": "string", "name": "type", "description": "" } ] }, { "type": "array of strings", "name": "schemas", "in": "body", "description": "" }, { "type": "string", "name": "externalId", "in": "body", "description": "" }, { "type": "array of strings", "name": "groups", "in": "body", "description": "" }, { "type": "boolean", "name": "active", "in": "body", "description": "" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/scim+json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Monalisa Octocat", "name": { "givenName": "Monalisa", "familyName": "Octocat", "formatted": "Monalisa Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true }, { "value": "monalisa@octocat.github.com" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } }, "schema": { "title": "SCIM /Users", "description": "SCIM /Users provisioning endpoints", "type": "object", "properties": { "schemas": { "description": "SCIM schema used.", "type": "array", "minItems": 1, "items": { "type": "string", "examples": [ "urn:ietf:params:scim:schemas:core:2.0:User" ] } }, "id": { "description": "Unique identifier of an external identity", "type": "string", "examples": [ "1b78eada-9baa-11e6-9eb6-a431576d590e" ] }, "externalId": { "description": "The ID of the User.", "type": [ "string", "null" ], "examples": [ "a7b0f98395" ] }, "userName": { "description": "Configured by the admin. Could be an email, login, or username", "type": [ "string", "null" ], "examples": [ "someone@example.com" ] }, "displayName": { "description": "The name of the user, suitable for display to end-users", "type": [ "string", "null" ], "examples": [ "Jon Doe" ] }, "name": { "type": "object", "properties": { "givenName": { "type": [ "string", "null" ] }, "familyName": { "type": [ "string", "null" ] }, "formatted": { "type": [ "string", "null" ] } }, "required": [ "givenName", "familyName" ], "example": { "givenName": "Jane", "familyName": "User" } }, "emails": { "description": "user emails", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "value": { "type": "string" }, "primary": { "type": "boolean" } }, "required": [ "value" ] }, "examples": [ { "value": "someone@example.com", "primary": true }, { "value": "another@example.com", "primary": false } ] }, "active": { "description": "The active status of the User.", "type": "boolean", "examples": [ true ] }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string", "examples": [ "User" ] }, "created": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "lastModified": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "location": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/scim/v2/organizations/myorg-123abc55141bfd8f/Users/c42772b5-2029-11e9-8543-9264a97dec8d" ] } } }, "organization_id": { "description": "The ID of the organization.", "type": "integer" }, "operations": { "description": "Set of operations to be performed", "type": "array", "minItems": 1, "items": { "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "object" }, { "type": "array", "items": {} } ] } }, "required": [ "op" ], "type": "object" }, "examples": [ { "op": "replace", "value": { "active": false } } ] }, "groups": { "description": "associated groups", "type": "array", "items": { "properties": { "value": { "type": "string" }, "display": { "type": "string" } } } } }, "required": [ "id", "schemas", "externalId", "userName", "name", "emails", "active", "meta" ] } } } ], "previews": [], "descriptionHTML": "Provision organization membership for a user, and send an activation email to the email address.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "scim" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/scim/v2/organizations/{org}/Users/{scim_user_id}", "title": "Get SCIM provisioning information for a user", "category": "scim", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scim_user_id", "description": "The unique identifier of the SCIM user.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", "contentType": "application/scim+json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Monalisa Octocat", "name": { "givenName": "Monalisa", "familyName": "Octocat", "formatted": "Monalisa Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true }, { "value": "monalisa@octocat.github.com" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } }, "schema": { "title": "SCIM /Users", "description": "SCIM /Users provisioning endpoints", "type": "object", "properties": { "schemas": { "description": "SCIM schema used.", "type": "array", "minItems": 1, "items": { "type": "string", "examples": [ "urn:ietf:params:scim:schemas:core:2.0:User" ] } }, "id": { "description": "Unique identifier of an external identity", "type": "string", "examples": [ "1b78eada-9baa-11e6-9eb6-a431576d590e" ] }, "externalId": { "description": "The ID of the User.", "type": [ "string", "null" ], "examples": [ "a7b0f98395" ] }, "userName": { "description": "Configured by the admin. Could be an email, login, or username", "type": [ "string", "null" ], "examples": [ "someone@example.com" ] }, "displayName": { "description": "The name of the user, suitable for display to end-users", "type": [ "string", "null" ], "examples": [ "Jon Doe" ] }, "name": { "type": "object", "properties": { "givenName": { "type": [ "string", "null" ] }, "familyName": { "type": [ "string", "null" ] }, "formatted": { "type": [ "string", "null" ] } }, "required": [ "givenName", "familyName" ], "example": { "givenName": "Jane", "familyName": "User" } }, "emails": { "description": "user emails", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "value": { "type": "string" }, "primary": { "type": "boolean" } }, "required": [ "value" ] }, "examples": [ { "value": "someone@example.com", "primary": true }, { "value": "another@example.com", "primary": false } ] }, "active": { "description": "The active status of the User.", "type": "boolean", "examples": [ true ] }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string", "examples": [ "User" ] }, "created": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "lastModified": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "location": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/scim/v2/organizations/myorg-123abc55141bfd8f/Users/c42772b5-2029-11e9-8543-9264a97dec8d" ] } } }, "organization_id": { "description": "The ID of the organization.", "type": "integer" }, "operations": { "description": "Set of operations to be performed", "type": "array", "minItems": 1, "items": { "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "object" }, { "type": "array", "items": {} } ] } }, "required": [ "op" ], "type": "object" }, "examples": [ { "op": "replace", "value": { "active": false } } ] }, "groups": { "description": "associated groups", "type": "array", "items": { "properties": { "value": { "type": "string" }, "display": { "type": "string" } } } } }, "required": [ "id", "schemas", "externalId", "userName", "name", "emails", "active", "meta" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "scim" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/scim/v2/organizations/{org}/Users/{scim_user_id}", "title": "Update a provisioned organization membership", "category": "scim", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scim_user_id", "description": "The unique identifier of the SCIM user.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of strings", "name": "schemas", "in": "body", "description": "" }, { "type": "string", "name": "displayName", "in": "body", "description": "The name of the user, suitable for display to end-users
" }, { "type": "string", "name": "externalId", "in": "body", "description": "" }, { "type": "array of strings", "name": "groups", "in": "body", "description": "" }, { "type": "boolean", "name": "active", "in": "body", "description": "" }, { "type": "string", "name": "userName", "in": "body", "description": "Configured by the admin. Could be an email, login, or username
", "isRequired": true }, { "type": "object", "name": "name", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "givenName", "description": "", "isRequired": true }, { "type": "string", "name": "familyName", "description": "", "isRequired": true }, { "type": "string", "name": "formatted", "description": "" } ] }, { "type": "array of objects", "name": "emails", "in": "body", "description": "user emails
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "type", "description": "" }, { "type": "string", "name": "value", "description": "", "isRequired": true }, { "type": "boolean", "name": "primary", "description": "" } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", "contentType": "application/scim+json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Monalisa Octocat", "name": { "givenName": "Monalisa", "familyName": "Octocat", "formatted": "Monalisa Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true }, { "value": "monalisa@octocat.github.com" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } }, "schema": { "title": "SCIM /Users", "description": "SCIM /Users provisioning endpoints", "type": "object", "properties": { "schemas": { "description": "SCIM schema used.", "type": "array", "minItems": 1, "items": { "type": "string", "examples": [ "urn:ietf:params:scim:schemas:core:2.0:User" ] } }, "id": { "description": "Unique identifier of an external identity", "type": "string", "examples": [ "1b78eada-9baa-11e6-9eb6-a431576d590e" ] }, "externalId": { "description": "The ID of the User.", "type": [ "string", "null" ], "examples": [ "a7b0f98395" ] }, "userName": { "description": "Configured by the admin. Could be an email, login, or username", "type": [ "string", "null" ], "examples": [ "someone@example.com" ] }, "displayName": { "description": "The name of the user, suitable for display to end-users", "type": [ "string", "null" ], "examples": [ "Jon Doe" ] }, "name": { "type": "object", "properties": { "givenName": { "type": [ "string", "null" ] }, "familyName": { "type": [ "string", "null" ] }, "formatted": { "type": [ "string", "null" ] } }, "required": [ "givenName", "familyName" ], "example": { "givenName": "Jane", "familyName": "User" } }, "emails": { "description": "user emails", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "value": { "type": "string" }, "primary": { "type": "boolean" } }, "required": [ "value" ] }, "examples": [ { "value": "someone@example.com", "primary": true }, { "value": "another@example.com", "primary": false } ] }, "active": { "description": "The active status of the User.", "type": "boolean", "examples": [ true ] }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string", "examples": [ "User" ] }, "created": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "lastModified": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "location": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/scim/v2/organizations/myorg-123abc55141bfd8f/Users/c42772b5-2029-11e9-8543-9264a97dec8d" ] } } }, "organization_id": { "description": "The ID of the organization.", "type": "integer" }, "operations": { "description": "Set of operations to be performed", "type": "array", "minItems": 1, "items": { "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "object" }, { "type": "array", "items": {} } ] } }, "required": [ "op" ], "type": "object" }, "examples": [ { "op": "replace", "value": { "active": false } } ] }, "groups": { "description": "associated groups", "type": "array", "items": { "properties": { "value": { "type": "string" }, "display": { "type": "string" } } } } }, "required": [ "id", "schemas", "externalId", "userName", "name", "emails", "active", "meta" ] } } } ], "previews": [], "descriptionHTML": "Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nYou must at least provide the required values for the user: userName, name, and emails.
Warning: Setting active: false removes the user from the organization, deletes the external identity, and deletes the associated {scim_user_id}.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "scim" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/scim/v2/organizations/{org}/Users/{scim_user_id}", "title": "Update an attribute for a SCIM user", "category": "scim", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scim_user_id", "description": "The unique identifier of the SCIM user.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of strings", "name": "schemas", "in": "body", "description": "" }, { "type": "array of objects", "name": "Operations", "in": "body", "description": "Set of operations to be performed
", "isRequired": true, "childParamsGroups": [ { "type": "string", "name": "op", "description": "", "isRequired": true, "enum": [ "add", "remove", "replace" ] }, { "type": "string", "name": "path", "description": "" }, { "type": "object or array or string", "name": "value", "description": "" } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", "contentType": "application/scim+json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Monalisa Octocat", "name": { "givenName": "Monalisa", "familyName": "Octocat", "formatted": "Monalisa Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true }, { "value": "monalisa@octocat.github.com" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } }, "schema": { "title": "SCIM /Users", "description": "SCIM /Users provisioning endpoints", "type": "object", "properties": { "schemas": { "description": "SCIM schema used.", "type": "array", "minItems": 1, "items": { "type": "string", "examples": [ "urn:ietf:params:scim:schemas:core:2.0:User" ] } }, "id": { "description": "Unique identifier of an external identity", "type": "string", "examples": [ "1b78eada-9baa-11e6-9eb6-a431576d590e" ] }, "externalId": { "description": "The ID of the User.", "type": [ "string", "null" ], "examples": [ "a7b0f98395" ] }, "userName": { "description": "Configured by the admin. Could be an email, login, or username", "type": [ "string", "null" ], "examples": [ "someone@example.com" ] }, "displayName": { "description": "The name of the user, suitable for display to end-users", "type": [ "string", "null" ], "examples": [ "Jon Doe" ] }, "name": { "type": "object", "properties": { "givenName": { "type": [ "string", "null" ] }, "familyName": { "type": [ "string", "null" ] }, "formatted": { "type": [ "string", "null" ] } }, "required": [ "givenName", "familyName" ], "example": { "givenName": "Jane", "familyName": "User" } }, "emails": { "description": "user emails", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "value": { "type": "string" }, "primary": { "type": "boolean" } }, "required": [ "value" ] }, "examples": [ { "value": "someone@example.com", "primary": true }, { "value": "another@example.com", "primary": false } ] }, "active": { "description": "The active status of the User.", "type": "boolean", "examples": [ true ] }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string", "examples": [ "User" ] }, "created": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "lastModified": { "type": "string", "format": "date-time", "examples": [ "2019-01-24T22:45:36.000Z" ] }, "location": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/scim/v2/organizations/myorg-123abc55141bfd8f/Users/c42772b5-2029-11e9-8543-9264a97dec8d" ] } } }, "organization_id": { "description": "The ID of the organization.", "type": "integer" }, "operations": { "description": "Set of operations to be performed", "type": "array", "minItems": 1, "items": { "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "object" }, { "type": "array", "items": {} } ] } }, "required": [ "op" ], "type": "object" }, "examples": [ { "op": "replace", "value": { "active": false } } ] }, "groups": { "description": "associated groups", "type": "array", "items": { "properties": { "value": { "type": "string" }, "display": { "type": "string" } } } } }, "required": [ "id", "schemas", "externalId", "userName", "name", "emails", "active", "meta" ] } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "429", "description": "Too Many Requests
" } ], "descriptionHTML": "Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note: Complicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning: If you set active:false using the replace operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated :scim_user_id.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nThe organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scim_user_id", "description": "The unique identifier of the SCIM user.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "scim" } ] }, "search": { "search": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/code", "title": "Search code", "category": "search", "parameters": [ { "name": "q", "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.
", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "description": "Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 7, "incomplete_results": false, "items": [ { "name": "classes.js", "path": "src/attributes/classes.js", "sha": "d7212f9dee2dcc18f084d7df8f417b80846ded5a", "url": "https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4", "git_url": "https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a", "html_url": "https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js", "repository": { "id": 167174, "node_id": "MDEwOlJlcG9zaXRvcnkxNjcxNzQ=", "name": "jquery", "full_name": "jquery/jquery", "owner": { "login": "jquery", "id": 70142, "node_id": "MDQ6VXNlcjcwMTQy", "avatar_url": "https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png", "gravatar_id": "", "url": "https://api.github.com/users/jquery", "html_url": "https://github.com/jquery", "followers_url": "https://api.github.com/users/jquery/followers", "following_url": "https://api.github.com/users/jquery/following{/other_user}", "gists_url": "https://api.github.com/users/jquery/gists{/gist_id}", "starred_url": "https://api.github.com/users/jquery/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/jquery/subscriptions", "organizations_url": "https://api.github.com/users/jquery/orgs", "repos_url": "https://api.github.com/users/jquery/repos", "events_url": "https://api.github.com/users/jquery/events{/privacy}", "received_events_url": "https://api.github.com/users/jquery/received_events", "type": "Organization", "site_admin": false }, "private": false, "html_url": "https://github.com/jquery/jquery", "description": "jQuery JavaScript Library", "fork": false, "url": "https://api.github.com/repos/jquery/jquery", "forks_url": "https://api.github.com/repos/jquery/jquery/forks", "keys_url": "https://api.github.com/repos/jquery/jquery/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/jquery/jquery/teams", "hooks_url": "https://api.github.com/repos/jquery/jquery/hooks", "issue_events_url": "https://api.github.com/repos/jquery/jquery/issues/events{/number}", "events_url": "https://api.github.com/repos/jquery/jquery/events", "assignees_url": "https://api.github.com/repos/jquery/jquery/assignees{/user}", "branches_url": "https://api.github.com/repos/jquery/jquery/branches{/branch}", "tags_url": "https://api.github.com/repos/jquery/jquery/tags", "blobs_url": "https://api.github.com/repos/jquery/jquery/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/jquery/jquery/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/jquery/jquery/git/refs{/sha}", "trees_url": "https://api.github.com/repos/jquery/jquery/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/jquery/jquery/statuses/{sha}", "languages_url": "https://api.github.com/repos/jquery/jquery/languages", "stargazers_url": "https://api.github.com/repos/jquery/jquery/stargazers", "contributors_url": "https://api.github.com/repos/jquery/jquery/contributors", "subscribers_url": "https://api.github.com/repos/jquery/jquery/subscribers", "subscription_url": "https://api.github.com/repos/jquery/jquery/subscription", "commits_url": "https://api.github.com/repos/jquery/jquery/commits{/sha}", "git_commits_url": "https://api.github.com/repos/jquery/jquery/git/commits{/sha}", "comments_url": "https://api.github.com/repos/jquery/jquery/comments{/number}", "issue_comment_url": "https://api.github.com/repos/jquery/jquery/issues/comments/{number}", "contents_url": "https://api.github.com/repos/jquery/jquery/contents/{+path}", "compare_url": "https://api.github.com/repos/jquery/jquery/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/jquery/jquery/merges", "archive_url": "https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/jquery/jquery/downloads", "issues_url": "https://api.github.com/repos/jquery/jquery/issues{/number}", "pulls_url": "https://api.github.com/repos/jquery/jquery/pulls{/number}", "milestones_url": "https://api.github.com/repos/jquery/jquery/milestones{/number}", "notifications_url": "https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/jquery/jquery/labels{/name}", "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments", "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "score": 1 } ] }, "schema": { "type": "object", "required": [ "total_count", "incomplete_results", "items" ], "properties": { "total_count": { "type": "integer" }, "incomplete_results": { "type": "boolean" }, "items": { "type": "array", "items": { "title": "Code Search Result Item", "description": "Code Search Result Item", "type": "object", "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "git_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "score": { "type": "number" }, "file_size": { "type": "integer" }, "language": { "type": [ "string", "null" ] }, "last_modified_at": { "type": "string", "format": "date-time" }, "line_numbers": { "type": "array", "items": { "type": "string" }, "examples": [ "73..77", "77..78" ] }, "text_matches": { "title": "Search Result Text Matches", "type": "array", "items": { "type": "object", "properties": { "object_url": { "type": "string" }, "object_type": { "type": [ "string", "null" ] }, "property": { "type": "string" }, "fragment": { "type": "string" }, "matches": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "indices": { "type": "array", "items": { "type": "integer" } } } } } } } } }, "required": [ "score", "name", "path", "sha", "git_url", "html_url", "url", "repository" ] } } } } } } ], "previews": [], "descriptionHTML": "Searches for query terms inside of a file. This method returns up to 100 results per page.
\nWhen searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
Considerations for code search
\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:
\n- \n
- Only the default branch is considered. In most cases, this will be the
masterbranch. \n - Only files smaller than 384 KB are searchable. \n
- You must always include at least one search term when searching source code. For example, searching for
language:gois not valid, whileamazing language:gois. \n
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "search" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/commits", "title": "Search commits", "category": "search", "parameters": [ { "name": "q", "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See \"Searching commits\" for a detailed list of qualifiers.
", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "description": "Sorts the results of your query by author-date or committer-date. Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "incomplete_results": false, "items": [ { "url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", "sha": "bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", "html_url": "https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", "comments_url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments", "commit": { "url": "https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", "author": { "date": "2014-02-04T14:38:36-08:00", "name": "The Octocat", "email": "octocat@nowhere.com" }, "committer": { "date": "2014-02-12T15:18:55-08:00", "name": "The Octocat", "email": "octocat@nowhere.com" }, "message": "Create styles.css and updated README", "tree": { "url": "https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68", "sha": "a639e96f9038797fba6e0469f94a4b0cc459fa68" }, "comment_count": 8 }, "author": { "login": "octocat", "id": 583231, "node_id": "MDQ6VXNlcjU4MzIzMQ==", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "committer": {}, "parents": [ { "url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4", "html_url": "https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4", "sha": "a30c19e3f13765a3b48829788bc1cb8b4e95cee4" } ], "repository": { "id": 1300192, "node_id": "MDEwOlJlcG9zaXRvcnkxMzAwMTky", "name": "Spoon-Knife", "full_name": "octocat/Spoon-Knife", "owner": { "login": "octocat", "id": 583231, "node_id": "MDQ6VXNlcjU4MzIzMQ==", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Spoon-Knife", "description": "This repo is for demonstration purposes only.", "fork": false, "url": "https://api.github.com/repos/octocat/Spoon-Knife", "forks_url": "https://api.github.com/repos/octocat/Spoon-Knife/forks", "keys_url": "https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/octocat/Spoon-Knife/teams", "hooks_url": "https://api.github.com/repos/octocat/Spoon-Knife/hooks", "issue_events_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}", "events_url": "https://api.github.com/repos/octocat/Spoon-Knife/events", "assignees_url": "https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}", "branches_url": "https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}", "tags_url": "https://api.github.com/repos/octocat/Spoon-Knife/tags", "blobs_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}", "trees_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}", "languages_url": "https://api.github.com/repos/octocat/Spoon-Knife/languages", "stargazers_url": "https://api.github.com/repos/octocat/Spoon-Knife/stargazers", "contributors_url": "https://api.github.com/repos/octocat/Spoon-Knife/contributors", "subscribers_url": "https://api.github.com/repos/octocat/Spoon-Knife/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Spoon-Knife/subscription", "commits_url": "https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}", "git_commits_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}", "comments_url": "https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}", "issue_comment_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}", "contents_url": "https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}", "compare_url": "https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/octocat/Spoon-Knife/merges", "archive_url": "https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/octocat/Spoon-Knife/downloads", "issues_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}", "pulls_url": "https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}", "milestones_url": "https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}", "releases_url": "https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}", "deployments_url": "https://api.github.com/repos/octocat/Spoon-Knife/deployments" }, "score": 1, "node_id": "MDQ6VXNlcjU4MzIzMQ==" } ] }, "schema": { "type": "object", "required": [ "total_count", "incomplete_results", "items" ], "properties": { "total_count": { "type": "integer" }, "incomplete_results": { "type": "boolean" }, "items": { "type": "array", "items": { "title": "Commit Search Result Item", "description": "Commit Search Result Item", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "sha": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "comments_url": { "type": "string", "format": "uri" }, "commit": { "type": "object", "properties": { "author": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "date": { "type": "string", "format": "date-time" } }, "required": [ "name", "email", "date" ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "comment_count": { "type": "integer" }, "message": { "type": "string" }, "tree": { "type": "object", "properties": { "sha": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "sha", "url" ] }, "url": { "type": "string", "format": "uri" }, "verification": { "title": "Verification", "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "payload": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "payload", "signature" ] } }, "required": [ "author", "committer", "comment_count", "message", "tree", "url" ] }, "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "committer": { "anyOf": [ { "type": "null" }, { "title": "Git User", "description": "Metaproperties for Git author/committer information.", "type": "object", "properties": { "name": { "type": "string", "examples": [ "\"Chris Wanstrath\"" ] }, "email": { "type": "string", "examples": [ "\"chris@ozmm.org\"" ] }, "date": { "type": "string", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] } } } ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "html_url": { "type": "string" }, "sha": { "type": "string" } } } }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "score": { "type": "number" }, "node_id": { "type": "string" }, "text_matches": { "title": "Search Result Text Matches", "type": "array", "items": { "type": "object", "properties": { "object_url": { "type": "string" }, "object_type": { "type": [ "string", "null" ] }, "property": { "type": "string" }, "fragment": { "type": "string" }, "matches": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "indices": { "type": "array", "items": { "type": "integer" } } } } } } } } }, "required": [ "sha", "node_id", "url", "html_url", "author", "committer", "parents", "comments_url", "commit", "repository", "score" ] } } } } } } ], "previews": [], "descriptionHTML": "Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "search" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/issues", "title": "Search issues and pull requests", "category": "search", "parameters": [ { "name": "q", "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See \"Searching issues and pull requests\" for a detailed list of qualifiers.
", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "description": "Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 280, "incomplete_results": false, "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit", "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments", "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events", "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", "id": 35802, "node_id": "MDU6SXNzdWUzNTgwMg==", "number": 132, "title": "Line Number Indexes Beyond 20 Not Displayed", "user": { "login": "Nick3C", "id": 90254, "node_id": "MDQ6VXNlcjkwMjU0", "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", "gravatar_id": "", "url": "https://api.github.com/users/Nick3C", "html_url": "https://github.com/Nick3C", "followers_url": "https://api.github.com/users/Nick3C/followers", "following_url": "https://api.github.com/users/Nick3C/following{/other_user}", "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}", "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions", "organizations_url": "https://api.github.com/users/Nick3C/orgs", "repos_url": "https://api.github.com/users/Nick3C/repos", "events_url": "https://api.github.com/users/Nick3C/events{/privacy}", "received_events_url": "https://api.github.com/users/Nick3C/received_events", "type": "User", "site_admin": true }, "labels": [ { "id": 4, "node_id": "MDU6TGFiZWw0", "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", "name": "bug", "color": "ff0000" } ], "state": "open", "assignee": null, "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "comments": 15, "created_at": "2009-07-12T20:10:41Z", "updated_at": "2009-07-19T09:23:43Z", "closed_at": null, "pull_request": { "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "body": "...", "score": 1, "locked": true, "author_association": "COLLABORATOR", "state_reason": "completed" } ] }, "schema": { "type": "object", "required": [ "total_count", "incomplete_results", "items" ], "properties": { "total_count": { "type": "integer" }, "incomplete_results": { "type": "boolean" }, "items": { "type": "array", "items": { "title": "Issue Search Result Item", "description": "Issue Search Result Item", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "number": { "type": "integer" }, "title": { "type": "string" }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "assignees": { "type": [ "array", "null" ], "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "default": { "type": "boolean" }, "description": { "type": [ "string", "null" ] } } } }, "state": { "type": "string" }, "state_reason": { "type": [ "string", "null" ] }, "assignee": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "milestone": { "anyOf": [ { "type": "null" }, { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [ 1002604 ] }, "node_id": { "type": "string", "examples": [ "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [ 42 ] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open", "examples": [ "open" ] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": [ "v1.0" ] }, "description": { "type": [ "string", "null" ], "examples": [ "Tracking milestone for version 1.0" ] }, "creator": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "open_issues": { "type": "integer", "examples": [ 4 ] }, "closed_issues": { "type": "integer", "examples": [ 8 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2014-03-03T18:58:10Z" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2013-02-12T13:22:01Z" ] }, "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2012-10-09T23:39:01Z" ] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] } ] }, "comments": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "text_matches": { "title": "Search Result Text Matches", "type": "array", "items": { "type": "object", "properties": { "object_url": { "type": "string" }, "object_type": { "type": [ "string", "null" ] }, "property": { "type": "string" }, "fragment": { "type": "string" }, "matches": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "indices": { "type": "array", "items": { "type": "integer" } } } } } } } }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "body": { "type": "string" }, "score": { "type": "number" }, "author_association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": [ "OWNER" ] }, "draft": { "type": "boolean" }, "repository": { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ 37 ] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": [ "probot-owners" ] }, "node_id": { "type": "string", "examples": [ "MDExOkludGVncmF0aW9uMQ==" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": [ "Probot Owners" ] }, "description": { "type": [ "string", "null" ], "examples": [ "The description of the app." ] }, "external_url": { "type": "string", "format": "uri", "examples": [ "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-08T16:18:44-04:00" ] }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ 5 ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "client_secret": { "type": "string", "examples": [ "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, "webhook_secret": { "type": [ "string", "null" ], "examples": [ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, "pem": { "type": "string", "examples": [ "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] } ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at", "score" ] } } } } } } ], "previews": [], "descriptionHTML": "Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "search" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/labels", "title": "Search labels", "category": "search", "parameters": [ { "name": "repository_id", "description": "The id of the repository.
", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "q", "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.
", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "description": "Sorts the results of your query by when the label was created or updated. Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "incomplete_results": false, "items": [ { "id": 418327088, "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement", "name": "enhancement", "color": "84b6eb", "default": true, "description": "New feature or request.", "score": 1 }, { "id": 418327086, "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", "url": "https://api.github.com/repos/octocat/linguist/labels/bug", "name": "bug", "color": "ee0701", "default": true, "description": "Something isn't working.", "score": 1 } ] }, "schema": { "type": "object", "required": [ "total_count", "incomplete_results", "items" ], "properties": { "total_count": { "type": "integer" }, "incomplete_results": { "type": "boolean" }, "items": { "type": "array", "items": { "title": "Label Search Result Item", "description": "Label Search Result Item", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "color": { "type": "string" }, "default": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "score": { "type": "number" }, "text_matches": { "title": "Search Result Text Matches", "type": "array", "items": { "type": "object", "properties": { "object_url": { "type": "string" }, "object_type": { "type": [ "string", "null" ] }, "property": { "type": "string" }, "fragment": { "type": "string" }, "matches": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "indices": { "type": "array", "items": { "type": "integer" } } } } } } } } }, "required": [ "id", "node_id", "url", "name", "color", "default", "description", "score" ] } } } } } } ], "previews": [], "descriptionHTML": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
\nWhen searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "search" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/repositories", "title": "Search repositories", "category": "search", "parameters": [ { "name": "q", "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.
", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "description": "Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 40, "incomplete_results": false, "items": [ { "id": 3081286, "node_id": "MDEwOlJlcG9zaXRvcnkzMDgxMjg2", "name": "Tetris", "full_name": "dtrupenn/Tetris", "owner": { "login": "dtrupenn", "id": 872147, "node_id": "MDQ6VXNlcjg3MjE0Nw==", "avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", "gravatar_id": "", "url": "https://api.github.com/users/dtrupenn", "received_events_url": "https://api.github.com/users/dtrupenn/received_events", "type": "User", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "site_admin": true }, "private": false, "html_url": "https://github.com/dtrupenn/Tetris", "description": "A C implementation of Tetris using Pennsim through LC4", "fork": false, "url": "https://api.github.com/repos/dtrupenn/Tetris", "created_at": "2012-01-01T00:31:50Z", "updated_at": "2013-01-05T17:58:47Z", "pushed_at": "2012-01-01T00:37:02Z", "homepage": "https://github.com", "size": 524, "stargazers_count": 1, "watchers_count": 1, "language": "Assembly", "forks_count": 0, "open_issues_count": 0, "master_branch": "master", "default_branch": "master", "score": 1, "archive_url": "https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}", "blobs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}", "collaborators_url": "https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/dtrupenn/Tetris/comments{/number}", "commits_url": "https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}", "compare_url": "https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}", "contributors_url": "https://api.github.com/repos/dtrupenn/Tetris/contributors", "deployments_url": "https://api.github.com/repos/dtrupenn/Tetris/deployments", "downloads_url": "https://api.github.com/repos/dtrupenn/Tetris/downloads", "events_url": "https://api.github.com/repos/dtrupenn/Tetris/events", "forks_url": "https://api.github.com/repos/dtrupenn/Tetris/forks", "git_commits_url": "https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}", "git_url": "git:github.com/dtrupenn/Tetris.git", "issue_comment_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}", "issues_url": "https://api.github.com/repos/dtrupenn/Tetris/issues{/number}", "keys_url": "https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}", "labels_url": "https://api.github.com/repos/dtrupenn/Tetris/labels{/name}", "languages_url": "https://api.github.com/repos/dtrupenn/Tetris/languages", "merges_url": "https://api.github.com/repos/dtrupenn/Tetris/merges", "milestones_url": "https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}", "notifications_url": "https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}", "releases_url": "https://api.github.com/repos/dtrupenn/Tetris/releases{/id}", "ssh_url": "git@github.com:dtrupenn/Tetris.git", "stargazers_url": "https://api.github.com/repos/dtrupenn/Tetris/stargazers", "statuses_url": "https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/dtrupenn/Tetris/subscribers", "subscription_url": "https://api.github.com/repos/dtrupenn/Tetris/subscription", "tags_url": "https://api.github.com/repos/dtrupenn/Tetris/tags", "teams_url": "https://api.github.com/repos/dtrupenn/Tetris/teams", "trees_url": "https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}", "clone_url": "https://github.com/dtrupenn/Tetris.git", "mirror_url": "git:git.example.com/dtrupenn/Tetris", "hooks_url": "https://api.github.com/repos/dtrupenn/Tetris/hooks", "svn_url": "https://svn.github.com/dtrupenn/Tetris", "forks": 1, "open_issues": 1, "watchers": 1, "has_issues": true, "has_projects": true, "has_pages": true, "has_wiki": true, "has_downloads": true, "archived": true, "disabled": true, "visibility": "private", "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" } } ] }, "schema": { "type": "object", "required": [ "total_count", "incomplete_results", "items" ], "properties": { "total_count": { "type": "integer" }, "incomplete_results": { "type": "boolean" }, "items": { "type": "array", "items": { "title": "Repo Search Result Item", "description": "Repo Search Result Item", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri" }, "description": { "type": [ "string", "null" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "pushed_at": { "type": "string", "format": "date-time" }, "homepage": { "type": [ "string", "null" ], "format": "uri" }, "size": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "open_issues_count": { "type": "integer" }, "master_branch": { "type": "string" }, "default_branch": { "type": "string" }, "score": { "type": "number" }, "forks_url": { "type": "string", "format": "uri" }, "keys_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "teams_url": { "type": "string", "format": "uri" }, "hooks_url": { "type": "string", "format": "uri" }, "issue_events_url": { "type": "string" }, "events_url": { "type": "string", "format": "uri" }, "assignees_url": { "type": "string" }, "branches_url": { "type": "string" }, "tags_url": { "type": "string", "format": "uri" }, "blobs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "trees_url": { "type": "string" }, "statuses_url": { "type": "string" }, "languages_url": { "type": "string", "format": "uri" }, "stargazers_url": { "type": "string", "format": "uri" }, "contributors_url": { "type": "string", "format": "uri" }, "subscribers_url": { "type": "string", "format": "uri" }, "subscription_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "comments_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "contents_url": { "type": "string" }, "compare_url": { "type": "string" }, "merges_url": { "type": "string", "format": "uri" }, "archive_url": { "type": "string" }, "downloads_url": { "type": "string", "format": "uri" }, "issues_url": { "type": "string" }, "pulls_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "labels_url": { "type": "string" }, "releases_url": { "type": "string" }, "deployments_url": { "type": "string", "format": "uri" }, "git_url": { "type": "string" }, "ssh_url": { "type": "string" }, "clone_url": { "type": "string" }, "svn_url": { "type": "string", "format": "uri" }, "forks": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "topics": { "type": "array", "items": { "type": "string" } }, "mirror_url": { "type": [ "string", "null" ], "format": "uri" }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "type": "string" }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "text_matches": { "title": "Search Result Text Matches", "type": "array", "items": { "type": "object", "properties": { "object_url": { "type": "string" }, "object_type": { "type": [ "string", "null" ] }, "property": { "type": "string" }, "fragment": { "type": "string" }, "matches": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "indices": { "type": "array", "items": { "type": "integer" } } } } } } } }, "temp_clone_token": { "type": "string" }, "allow_merge_commit": { "type": "boolean" }, "allow_squash_merge": { "type": "boolean" }, "allow_rebase_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_forking": { "type": "boolean" }, "is_template": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at", "score" ] } } } } } } ], "previews": [], "descriptionHTML": "Find repositories via various criteria. This method returns up to 100 results per page.
\nWhen searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
\nq=tetris+language:assembly&sort=stars&order=desc
This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "search" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/topics", "title": "Search topics", "category": "search", "parameters": [ { "name": "q", "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query.
", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 6, "incomplete_results": false, "items": [ { "name": "ruby", "display_name": "Ruby", "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.", "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.", "created_by": "Yukihiro Matsumoto", "released": "December 21, 1995", "created_at": "2016-11-28T22:03:59Z", "updated_at": "2017-10-30T18:16:32Z", "featured": true, "curated": true, "score": 1 }, { "name": "rails", "display_name": "Rails", "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.", "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.", "created_by": "David Heinemeier Hansson", "released": "December 13 2005", "created_at": "2016-12-09T17:03:50Z", "updated_at": "2017-10-30T16:20:19Z", "featured": true, "curated": true, "score": 1 }, { "name": "python", "display_name": "Python", "short_description": "Python is a dynamically typed programming language.", "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.", "created_by": "Guido van Rossum", "released": "February 20, 1991", "created_at": "2016-12-07T00:07:02Z", "updated_at": "2017-10-27T22:45:43Z", "featured": true, "curated": true, "score": 1 }, { "name": "jekyll", "display_name": "Jekyll", "short_description": "Jekyll is a simple, blog-aware static site generator.", "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.", "created_by": "Tom Preston-Werner", "released": "2008", "created_at": "2016-12-16T21:53:08Z", "updated_at": "2017-10-27T19:00:24Z", "featured": true, "curated": true, "score": 1 }, { "name": "sass", "display_name": "Sass", "short_description": "Sass is a stable extension to classic CSS.", "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.", "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein", "released": "November 28, 2006", "created_at": "2016-12-16T21:53:45Z", "updated_at": "2018-01-16T16:30:40Z", "featured": true, "curated": true, "score": 1 }, { "name": "homebrew", "display_name": "Homebrew", "short_description": "Homebrew is a package manager for macOS.", "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.", "created_by": "Max Howell", "released": "2009", "created_at": "2016-12-17T20:30:44Z", "updated_at": "2018-02-06T16:14:56Z", "featured": true, "curated": true, "score": 1 } ] }, "schema": { "type": "object", "required": [ "total_count", "incomplete_results", "items" ], "properties": { "total_count": { "type": "integer" }, "incomplete_results": { "type": "boolean" }, "items": { "type": "array", "items": { "title": "Topic Search Result Item", "description": "Topic Search Result Item", "type": "object", "properties": { "name": { "type": "string" }, "display_name": { "type": [ "string", "null" ] }, "short_description": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "created_by": { "type": [ "string", "null" ] }, "released": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "featured": { "type": "boolean" }, "curated": { "type": "boolean" }, "score": { "type": "number" }, "repository_count": { "type": [ "integer", "null" ] }, "logo_url": { "type": [ "string", "null" ], "format": "uri" }, "text_matches": { "title": "Search Result Text Matches", "type": "array", "items": { "type": "object", "properties": { "object_url": { "type": "string" }, "object_type": { "type": [ "string", "null" ] }, "property": { "type": "string" }, "fragment": { "type": "string" }, "matches": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "indices": { "type": "array", "items": { "type": "integer" } } } } } } } }, "related": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "topic_relation": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "topic_id": { "type": "integer" }, "relation_type": { "type": "string" } } } } } }, "aliases": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "topic_relation": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "topic_id": { "type": "integer" }, "relation_type": { "type": "string" } } } } } } }, "required": [ "name", "display_name", "short_description", "description", "created_by", "released", "created_at", "updated_at", "featured", "curated", "score" ] } } } } } } ], "previews": [], "descriptionHTML": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\nWhen searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "search" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/users", "title": "Search users", "category": "search", "parameters": [ { "name": "q", "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See \"Searching users\" for a detailed list of qualifiers.
", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "description": "Sorts the results of your query by number of followers or repositories, or when the person joined GitHub. Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 12, "incomplete_results": false, "items": [ { "login": "mojombo", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", "gravatar_id": "", "url": "https://api.github.com/users/mojombo", "html_url": "https://github.com/mojombo", "followers_url": "https://api.github.com/users/mojombo/followers", "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions", "organizations_url": "https://api.github.com/users/mojombo/orgs", "repos_url": "https://api.github.com/users/mojombo/repos", "received_events_url": "https://api.github.com/users/mojombo/received_events", "type": "User", "score": 1, "following_url": "https://api.github.com/users/mojombo/following{/other_user}", "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}", "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}", "events_url": "https://api.github.com/users/mojombo/events{/privacy}", "site_admin": true } ] }, "schema": { "type": "object", "required": [ "total_count", "incomplete_results", "items" ], "properties": { "total_count": { "type": "integer" }, "incomplete_results": { "type": "boolean" }, "items": { "type": "array", "items": { "title": "User Search Result Item", "description": "User Search Result Item", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "score": { "type": "number" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "events_url": { "type": "string" }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "name": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "location": { "type": [ "string", "null" ] }, "site_admin": { "type": "boolean" }, "hireable": { "type": [ "boolean", "null" ] }, "text_matches": { "title": "Search Result Text Matches", "type": "array", "items": { "type": "object", "properties": { "object_url": { "type": "string" }, "object_type": { "type": [ "string", "null" ] }, "property": { "type": "string" }, "fragment": { "type": "string" }, "matches": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "indices": { "type": "array", "items": { "type": "integer" } } } } } } } }, "blog": { "type": [ "string", "null" ] }, "company": { "type": [ "string", "null" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "score" ] } } } } } } ], "previews": [], "descriptionHTML": "Find users via various criteria. This method returns up to 100 results per page.
\nWhen searching for users, you can get text match metadata for the issue login, public email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you're looking for a list of popular users, you might try this query:
\nq=tom+repos:%3E42+followers:%3E1000
This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "search" } ] }, "secret-scanning": { "secret-scanning": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/secret-scanning/alerts", "title": "List secret scanning alerts for an enterprise", "category": "secret-scanning", "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Set to open or resolved to only list secret scanning alerts in a specific state.
A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", "required": false, "schema": { "type": "string" } }, { "name": "resolution", "in": "query", "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "before", "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "number": 2, "created_at": "2020-11-06T18:48:51Z", "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", "state": "resolved", "resolution": "false_positive", "resolved_at": "2020-11-07T02:47:13Z", "resolved_by": { "login": "monalisa", "id": 2, "node_id": "MDQ6VXNlcjI=", "avatar_url": "https://alambic.github.com/avatars/u/2?", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "secret_type": "adafruit_io_key", "secret_type_display_name": "Adafruit IO Key", "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" }, "push_protection_bypassed_by": { "login": "monalisa", "id": 2, "node_id": "MDQ6VXNlcjI=", "avatar_url": "https://alambic.github.com/avatars/u/2?", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z" }, { "number": 1, "created_at": "2020-11-06T18:18:30Z", "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", "html_url": "https://github.com/owner/repo/security/secret-scanning/1", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", "state": "open", "resolution": null, "resolved_at": null, "resolved_by": null, "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" }, "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null } ], "schema": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "created_at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "anyOf": [ { "type": "null" }, { "type": "string", "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true } ] }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true }, "html_url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", "readOnly": true }, "locations_url": { "type": "string", "format": "uri", "description": "The REST API URL of the code locations for this alert." }, "state": { "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", "type": "string", "enum": [ "open", "resolved" ] }, "resolution": { "type": [ "string", "null" ], "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", "enum": [ null, "false_positive", "wont_fix", "revoked", "used_in_tests" ] }, "resolved_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, "resolved_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "secret_type": { "type": "string", "description": "The type of secret that secret scanning detected." }, "secret_type_display_name": { "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" }, "secret": { "type": "string", "description": "The secret that was detected." }, "repository": { "title": "Simple Repository", "description": "Simple Repository", "type": "object", "properties": { "id": { "type": "integer", "description": "A unique identifier of the repository.", "examples": [ 1296269 ] }, "node_id": { "type": "string", "description": "The GraphQL identifier of the repository.", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "description": "The name of the repository.", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "description": "The full, globally unique, name of the repository.", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", "description": "The URL to view the repository on GitHub.com.", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "description": "The repository description.", "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean", "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", "description": "The URL to get more information about the repository from the GitHub API.", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "description": "A template for the API URL to download the repository as an archive.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "description": "A template for the API URL to list the available assignees for issues in the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "description": "A template for the API URL to get information about branches in the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "description": "A template for the API URL to get information about collaborators of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "description": "A template for the API URL to get information about comments on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "description": "A template for the API URL to get information about commits on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "description": "A template for the API URL to compare two commits or refs.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "description": "A template for the API URL to get the contents of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "description": "A template for the API URL to list the contributors to the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "description": "The API URL to list the deployments of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "description": "The API URL to list the downloads on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "description": "The API URL to list the events of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "description": "The API URL to list the forks of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "description": "A template for the API URL to get information about Git commits of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "description": "A template for the API URL to get information about Git refs of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "description": "A template for the API URL to get information about Git tags of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "issue_comment_url": { "type": "string", "description": "A template for the API URL to get information about issue comments on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "description": "A template for the API URL to get information about issue events on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "description": "A template for the API URL to get information about issues on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "description": "A template for the API URL to get information about deploy keys on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "description": "A template for the API URL to get information about labels of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "description": "The API URL to get information about the languages of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "description": "The API URL to merge branches in the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "description": "A template for the API URL to get information about milestones of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "description": "A template for the API URL to get information about notifications on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "description": "A template for the API URL to get information about pull requests on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "description": "A template for the API URL to get information about releases on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "stargazers_url": { "type": "string", "format": "uri", "description": "The API URL to list the stargazers on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "description": "A template for the API URL to get information about statuses of a commit.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "description": "The API URL to list the subscribers on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "description": "The API URL to subscribe to notifications for this repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "description": "The API URL to get information about tags on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "description": "The API URL to list the teams on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "hooks_url": { "type": "string", "format": "uri", "description": "The API URL to list the hooks on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks" ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "push_protection_bypassed": { "type": [ "boolean", "null" ], "description": "Whether push protection was bypassed for the detected secret." }, "push_protection_bypassed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "push_protection_bypassed_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." } } } } } } ], "previews": [], "descriptionHTML": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the repo scope or security_events scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "secret-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/secret-scanning/alerts", "title": "List secret scanning alerts for an organization", "category": "secret-scanning", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Set to open or resolved to only list secret scanning alerts in a specific state.
A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", "required": false, "schema": { "type": "string" } }, { "name": "resolution", "in": "query", "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "before", "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", "in": "query", "required": false, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "number": 2, "created_at": "2020-11-06T18:48:51Z", "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", "state": "resolved", "resolution": "false_positive", "resolved_at": "2020-11-07T02:47:13Z", "resolved_by": { "login": "monalisa", "id": 2, "node_id": "MDQ6VXNlcjI=", "avatar_url": "https://alambic.github.com/avatars/u/2?", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "secret_type": "adafruit_io_key", "secret_type_display_name": "Adafruit IO Key", "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" }, "push_protection_bypassed_by": { "login": "monalisa", "id": 2, "node_id": "MDQ6VXNlcjI=", "avatar_url": "https://alambic.github.com/avatars/u/2?", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z" }, { "number": 1, "created_at": "2020-11-06T18:18:30Z", "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", "html_url": "https://github.com/owner/repo/security/secret-scanning/1", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", "state": "open", "resolution": null, "resolved_at": null, "resolved_by": null, "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" }, "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null } ], "schema": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "created_at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "anyOf": [ { "type": "null" }, { "type": "string", "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true } ] }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true }, "html_url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", "readOnly": true }, "locations_url": { "type": "string", "format": "uri", "description": "The REST API URL of the code locations for this alert." }, "state": { "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", "type": "string", "enum": [ "open", "resolved" ] }, "resolution": { "type": [ "string", "null" ], "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", "enum": [ null, "false_positive", "wont_fix", "revoked", "used_in_tests" ] }, "resolved_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, "resolved_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "secret_type": { "type": "string", "description": "The type of secret that secret scanning detected." }, "secret_type_display_name": { "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" }, "secret": { "type": "string", "description": "The secret that was detected." }, "repository": { "title": "Simple Repository", "description": "Simple Repository", "type": "object", "properties": { "id": { "type": "integer", "description": "A unique identifier of the repository.", "examples": [ 1296269 ] }, "node_id": { "type": "string", "description": "The GraphQL identifier of the repository.", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "description": "The name of the repository.", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "description": "The full, globally unique, name of the repository.", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", "description": "The URL to view the repository on GitHub.com.", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "description": "The repository description.", "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean", "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", "description": "The URL to get more information about the repository from the GitHub API.", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "description": "A template for the API URL to download the repository as an archive.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "description": "A template for the API URL to list the available assignees for issues in the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "description": "A template for the API URL to get information about branches in the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "description": "A template for the API URL to get information about collaborators of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "description": "A template for the API URL to get information about comments on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "description": "A template for the API URL to get information about commits on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "description": "A template for the API URL to compare two commits or refs.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "description": "A template for the API URL to get the contents of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "description": "A template for the API URL to list the contributors to the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "description": "The API URL to list the deployments of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "description": "The API URL to list the downloads on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "description": "The API URL to list the events of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "description": "The API URL to list the forks of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "description": "A template for the API URL to get information about Git commits of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "description": "A template for the API URL to get information about Git refs of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "description": "A template for the API URL to get information about Git tags of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "issue_comment_url": { "type": "string", "description": "A template for the API URL to get information about issue comments on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "description": "A template for the API URL to get information about issue events on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "description": "A template for the API URL to get information about issues on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "description": "A template for the API URL to get information about deploy keys on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "description": "A template for the API URL to get information about labels of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "description": "The API URL to get information about the languages of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "description": "The API URL to merge branches in the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "description": "A template for the API URL to get information about milestones of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "description": "A template for the API URL to get information about notifications on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "description": "A template for the API URL to get information about pull requests on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "description": "A template for the API URL to get information about releases on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "stargazers_url": { "type": "string", "format": "uri", "description": "The API URL to list the stargazers on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "description": "A template for the API URL to get information about statuses of a commit.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "description": "The API URL to list the subscribers on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "description": "The API URL to subscribe to notifications for this repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "description": "The API URL to get information about tags on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "description": "The API URL to list the teams on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "hooks_url": { "type": "string", "format": "uri", "description": "The API URL to list the hooks on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks" ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "push_protection_bypassed": { "type": [ "boolean", "null" ], "description": "Whether push protection was bypassed for the detected secret." }, "push_protection_bypassed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "push_protection_bypassed_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." } } } } } } ], "previews": [], "descriptionHTML": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "secret-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts", "title": "List secret scanning alerts for a repository", "category": "secret-scanning", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Set to open or resolved to only list secret scanning alerts in a specific state.
A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", "required": false, "schema": { "type": "string" } }, { "name": "resolution", "in": "query", "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "before", "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", "in": "query", "required": false, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "number": 2, "created_at": "2020-11-06T18:48:51Z", "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", "state": "resolved", "resolution": "false_positive", "resolved_at": "2020-11-07T02:47:13Z", "resolved_by": { "login": "monalisa", "id": 2, "node_id": "MDQ6VXNlcjI=", "avatar_url": "https://alambic.github.com/avatars/u/2?", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "secret_type": "adafruit_io_key", "secret_type_display_name": "Adafruit IO Key", "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", "push_protection_bypassed_by": { "login": "monalisa", "id": 2, "node_id": "MDQ6VXNlcjI=", "avatar_url": "https://alambic.github.com/avatars/u/2?", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z" }, { "number": 1, "created_at": "2020-11-06T18:18:30Z", "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", "html_url": "https://github.com/owner/repo/security/secret-scanning/1", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", "state": "open", "resolution": null, "resolved_at": null, "resolved_by": null, "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null } ], "schema": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "created_at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true }, "html_url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", "readOnly": true }, "locations_url": { "type": "string", "format": "uri", "description": "The REST API URL of the code locations for this alert." }, "state": { "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", "type": "string", "enum": [ "open", "resolved" ] }, "resolution": { "type": [ "string", "null" ], "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", "enum": [ null, "false_positive", "wont_fix", "revoked", "used_in_tests" ] }, "resolved_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, "resolved_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "secret_type": { "type": "string", "description": "The type of secret that secret scanning detected." }, "secret_type_display_name": { "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" }, "secret": { "type": "string", "description": "The secret that was detected." }, "push_protection_bypassed": { "type": [ "boolean", "null" ], "description": "Whether push protection was bypassed for the detected secret." }, "push_protection_bypassed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "push_protection_bypassed_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." } } } } } } ], "previews": [], "descriptionHTML": "Lists secret scanning alerts for an eligible repository, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Repository is public or secret scanning is disabled for the repository
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "secret-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "title": "Get a secret scanning alert", "category": "secret-scanning", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alert_number", "in": "path", "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Response
", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", "state": "open", "resolution": null, "resolved_at": null, "resolved_by": null, "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null }, "schema": { "type": "object", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "created_at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true }, "html_url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", "readOnly": true }, "locations_url": { "type": "string", "format": "uri", "description": "The REST API URL of the code locations for this alert." }, "state": { "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", "type": "string", "enum": [ "open", "resolved" ] }, "resolution": { "type": [ "string", "null" ], "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", "enum": [ null, "false_positive", "wont_fix", "revoked", "used_in_tests" ] }, "resolved_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, "resolved_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "secret_type": { "type": "string", "description": "The type of secret that secret scanning detected." }, "secret_type_display_name": { "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" }, "secret": { "type": "string", "description": "The secret that was detected." }, "push_protection_bypassed": { "type": [ "boolean", "null" ], "description": "Whether push protection was bypassed for the detected secret." }, "push_protection_bypassed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "push_protection_bypassed_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." } } } } } ], "previews": [], "descriptionHTML": "Gets a single secret scanning alert detected in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "secret-scanning" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "title": "Update a secret scanning alert", "category": "secret-scanning", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alert_number", "in": "path", "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
Response
", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", "state": "resolved", "resolution": "used_in_tests", "resolved_at": "2020-11-16T22:42:07Z", "resolved_by": { "login": "monalisa", "id": 2, "node_id": "MDQ6VXNlcjI=", "avatar_url": "https://alambic.github.com/avatars/u/2?", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", "push_protection_bypassed": false, "push_protection_bypassed_by": null, "push_protection_bypassed_at": null }, "schema": { "type": "object", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "created_at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true }, "html_url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", "readOnly": true }, "locations_url": { "type": "string", "format": "uri", "description": "The REST API URL of the code locations for this alert." }, "state": { "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", "type": "string", "enum": [ "open", "resolved" ] }, "resolution": { "type": [ "string", "null" ], "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", "enum": [ null, "false_positive", "wont_fix", "revoked", "used_in_tests" ] }, "resolved_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, "resolved_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "secret_type": { "type": "string", "description": "The type of secret that secret scanning detected." }, "secret_type_display_name": { "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" }, "secret": { "type": "string", "description": "The secret that was detected." }, "push_protection_bypassed": { "type": [ "boolean", "null" ], "description": "Whether push protection was bypassed for the detected secret." }, "push_protection_bypassed_by": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "push_protection_bypassed_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." } } } } } ], "previews": [], "descriptionHTML": "Updates the status of a secret scanning alert in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" }, { "httpStatusCode": "422", "description": "State does not match the resolution
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "secret-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", "title": "List locations for a secret scanning alert", "category": "secret-scanning", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alert_number", "in": "path", "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "alert_number": "ALERT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "type": "commit", "details": { "path": "/example/secrets.txt", "start_line": 1, "end_line": 1, "start_column": 1, "end_column": 64, "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" } }, { "type": "commit", "details": { "path": "/example/secrets.txt", "start_line": 5, "end_line": 5, "start_column": 1, "end_column": 64, "blob_sha": "9def38117ab2d8355b982429aa924e268b4b0065", "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/9def38117ab2d8355b982429aa924e268b4b0065", "commit_sha": "588483b99a46342501d99e3f10630cfc1219ea32", "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/588483b99a46342501d99e3f10630cfc1219ea32" } }, { "type": "commit", "details": { "path": "/example/secrets.txt", "start_line": 12, "end_line": 12, "start_column": 1, "end_column": 64, "blob_sha": "0b33e9c66e19f7fb15137a82ff1c04c10cba6caf", "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/0b33e9c66e19f7fb15137a82ff1c04c10cba6caf", "commit_sha": "9def38117ab2d8355b982429aa924e268b4b0065", "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/9def38117ab2d8355b982429aa924e268b4b0065" } } ], "schema": { "type": "array", "description": "List of locations where the secret was detected", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "commit" ], "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found.", "examples": [ "commit" ] }, "details": { "oneOf": [ { "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", "type": "object", "properties": { "path": { "type": "string", "description": "The file path in the repository", "examples": [ "/example/secrets.txt" ] }, "start_line": { "type": "number", "description": "Line number at which the secret starts in the file" }, "end_line": { "type": "number", "description": "Line number at which the secret ends in the file" }, "start_column": { "type": "number", "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" }, "end_column": { "type": "number", "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" }, "blob_sha": { "type": "string", "description": "SHA-1 hash ID of the associated blob", "examples": [ "af5626b4a114abcb82d63db7c8082c3c4756e51b" ] }, "blob_url": { "type": "string", "description": "The API URL to get the associated blob resource" }, "commit_sha": { "type": "string", "description": "SHA-1 hash ID of the associated commit", "examples": [ "af5626b4a114abcb82d63db7c8082c3c4756e51b" ] }, "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" } }, "required": [ "path", "start_line", "end_line", "start_column", "end_column", "blob_sha", "blob_url", "commit_sha", "commit_url" ] } ] } }, "required": [ "type", "details" ] } } } } ], "previews": [], "descriptionHTML": "Lists all locations for a given secret scanning alert for an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "secret-scanning" } ] }, "teams": { "teams": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams", "title": "List teams", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "schema": { "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } } } } ], "previews": [], "descriptionHTML": "Lists all teams in an organization that are visible to the authenticated user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/teams", "title": "Create a team", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name of the team.
", "isRequired": true }, { "type": "string", "name": "description", "in": "body", "description": "The description of the team.
" }, { "type": "array of strings", "name": "maintainers", "in": "body", "description": "List GitHub IDs for organization members who will become team maintainers.
" }, { "type": "array of strings", "name": "repo_names", "in": "body", "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.
" }, { "type": "string", "name": "privacy", "in": "body", "description": "The level of privacy this team should have. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nDefault: secret
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
\nDefault for child team: closed
Deprecated. The permission that new repositories will be added to the team with when none is specified.
", "enum": [ "pull", "push" ], "default": "pull" }, { "type": "integer", "name": "parent_team_id", "in": "body", "description": "The ID of a team to set as the parent team.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Justice League", "description": "A great team", "permission": "push", "privacy": "closed" }, "parameters": { "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "is_verified": true, "has_organization_projects": true, "has_repository_projects": true, "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "html_url": "https://github.com/octocat", "created_at": "2008-01-14T04:33:35Z", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } }, "schema": { "title": "Full Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Developers" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great team." ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "enum": [ "closed", "secret" ], "examples": [ "closed" ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "push" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] }, "members_count": { "type": "integer", "examples": [ 3 ] }, "repos_count": { "type": "integer", "examples": [ 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-08-17T12:37:15Z" ] }, "organization": { "title": "Team Organization", "description": "Team Organization", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] }, "name": { "type": "string", "examples": [ "github" ] }, "company": { "type": "string", "examples": [ "GitHub" ] }, "blog": { "type": "string", "format": "uri", "examples": [ "https://github.com/blog" ] }, "location": { "type": "string", "examples": [ "San Francisco" ] }, "email": { "type": "string", "format": "email", "examples": [ "octocat@github.com" ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "github" ] }, "is_verified": { "type": "boolean", "examples": [ true ] }, "has_organization_projects": { "type": "boolean", "examples": [ true ] }, "has_repository_projects": { "type": "boolean", "examples": [ true ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "type": { "type": "string", "examples": [ "Organization" ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "private_gists": { "type": [ "integer", "null" ], "examples": [ 81 ] }, "disk_usage": { "type": [ "integer", "null" ], "examples": [ 10000 ] }, "collaborators": { "type": [ "integer", "null" ], "examples": [ 8 ] }, "billing_email": { "type": [ "string", "null" ], "format": "email", "examples": [ "org@example.com" ] }, "plan": { "type": "object", "properties": { "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" }, "filled_seats": { "type": "integer" }, "seats": { "type": "integer" } }, "required": [ "name", "space", "private_repos" ] }, "default_repository_permission": { "type": [ "string", "null" ] }, "members_can_create_repositories": { "type": [ "boolean", "null" ], "examples": [ true ] }, "two_factor_requirement_enabled": { "type": [ "boolean", "null" ], "examples": [ true ] }, "members_allowed_repository_creation_type": { "type": "string", "examples": [ "all" ] }, "members_can_create_public_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_internal_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_public_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_pages": { "type": "boolean", "examples": [ true ] }, "members_can_fork_private_repositories": { "type": [ "boolean", "null" ], "examples": [ false ] }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description", "html_url", "has_organization_projects", "has_repository_projects", "public_repos", "public_gists", "followers", "following", "type", "created_at", "updated_at" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "created_at", "updated_at", "members_count", "repos_count", "organization" ] } } } ], "previews": [], "descriptionHTML": "To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".
Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}", "title": "Get a team by name", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "is_verified": true, "has_organization_projects": true, "has_repository_projects": true, "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "html_url": "https://github.com/octocat", "created_at": "2008-01-14T04:33:35Z", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } }, "schema": { "title": "Full Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Developers" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great team." ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "enum": [ "closed", "secret" ], "examples": [ "closed" ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "push" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] }, "members_count": { "type": "integer", "examples": [ 3 ] }, "repos_count": { "type": "integer", "examples": [ 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-08-17T12:37:15Z" ] }, "organization": { "title": "Team Organization", "description": "Team Organization", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] }, "name": { "type": "string", "examples": [ "github" ] }, "company": { "type": "string", "examples": [ "GitHub" ] }, "blog": { "type": "string", "format": "uri", "examples": [ "https://github.com/blog" ] }, "location": { "type": "string", "examples": [ "San Francisco" ] }, "email": { "type": "string", "format": "email", "examples": [ "octocat@github.com" ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "github" ] }, "is_verified": { "type": "boolean", "examples": [ true ] }, "has_organization_projects": { "type": "boolean", "examples": [ true ] }, "has_repository_projects": { "type": "boolean", "examples": [ true ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "type": { "type": "string", "examples": [ "Organization" ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "private_gists": { "type": [ "integer", "null" ], "examples": [ 81 ] }, "disk_usage": { "type": [ "integer", "null" ], "examples": [ 10000 ] }, "collaborators": { "type": [ "integer", "null" ], "examples": [ 8 ] }, "billing_email": { "type": [ "string", "null" ], "format": "email", "examples": [ "org@example.com" ] }, "plan": { "type": "object", "properties": { "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" }, "filled_seats": { "type": "integer" }, "seats": { "type": "integer" } }, "required": [ "name", "space", "private_repos" ] }, "default_repository_permission": { "type": [ "string", "null" ] }, "members_can_create_repositories": { "type": [ "boolean", "null" ], "examples": [ true ] }, "two_factor_requirement_enabled": { "type": [ "boolean", "null" ], "examples": [ true ] }, "members_allowed_repository_creation_type": { "type": "string", "examples": [ "all" ] }, "members_can_create_public_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_internal_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_public_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_pages": { "type": "boolean", "examples": [ true ] }, "members_can_fork_private_repositories": { "type": [ "boolean", "null" ], "examples": [ false ] }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description", "html_url", "has_organization_projects", "has_repository_projects", "public_repos", "public_gists", "followers", "following", "type", "created_at", "updated_at" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "created_at", "updated_at", "members_count", "repos_count", "organization" ] } } } ], "previews": [], "descriptionHTML": "Gets a team using the team's slug. GitHub generates the slug from the team name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}", "title": "Update a team", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name of the team.
" }, { "type": "string", "name": "description", "in": "body", "description": "The description of the team.
" }, { "type": "string", "name": "privacy", "in": "body", "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
Deprecated. The permission that new repositories will be added to the team with when none is specified.
", "enum": [ "pull", "push", "admin" ], "default": "pull" }, { "type": "integer or null", "name": "parent_team_id", "in": "body", "description": "The ID of a team to set as the parent team.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", "description": "new team description", "privacy": "closed" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "is_verified": true, "has_organization_projects": true, "has_repository_projects": true, "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "html_url": "https://github.com/octocat", "created_at": "2008-01-14T04:33:35Z", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } }, "schema": { "title": "Full Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Developers" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great team." ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "enum": [ "closed", "secret" ], "examples": [ "closed" ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "push" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] }, "members_count": { "type": "integer", "examples": [ 3 ] }, "repos_count": { "type": "integer", "examples": [ 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-08-17T12:37:15Z" ] }, "organization": { "title": "Team Organization", "description": "Team Organization", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] }, "name": { "type": "string", "examples": [ "github" ] }, "company": { "type": "string", "examples": [ "GitHub" ] }, "blog": { "type": "string", "format": "uri", "examples": [ "https://github.com/blog" ] }, "location": { "type": "string", "examples": [ "San Francisco" ] }, "email": { "type": "string", "format": "email", "examples": [ "octocat@github.com" ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "github" ] }, "is_verified": { "type": "boolean", "examples": [ true ] }, "has_organization_projects": { "type": "boolean", "examples": [ true ] }, "has_repository_projects": { "type": "boolean", "examples": [ true ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "type": { "type": "string", "examples": [ "Organization" ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "private_gists": { "type": [ "integer", "null" ], "examples": [ 81 ] }, "disk_usage": { "type": [ "integer", "null" ], "examples": [ 10000 ] }, "collaborators": { "type": [ "integer", "null" ], "examples": [ 8 ] }, "billing_email": { "type": [ "string", "null" ], "format": "email", "examples": [ "org@example.com" ] }, "plan": { "type": "object", "properties": { "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" }, "filled_seats": { "type": "integer" }, "seats": { "type": "integer" } }, "required": [ "name", "space", "private_repos" ] }, "default_repository_permission": { "type": [ "string", "null" ] }, "members_can_create_repositories": { "type": [ "boolean", "null" ], "examples": [ true ] }, "two_factor_requirement_enabled": { "type": [ "boolean", "null" ], "examples": [ true ] }, "members_allowed_repository_creation_type": { "type": "string", "examples": [ "all" ] }, "members_can_create_public_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_internal_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_public_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_pages": { "type": "boolean", "examples": [ true ] }, "members_can_fork_private_repositories": { "type": [ "boolean", "null" ], "examples": [ false ] }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description", "html_url", "has_organization_projects", "has_repository_projects", "public_repos", "public_gists", "followers", "following", "type", "created_at", "updated_at" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "created_at", "updated_at", "members_count", "repos_count", "organization" ] } } } ], "previews": [], "descriptionHTML": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
Created
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}", "title": "Delete a team", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
No Content
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/projects", "title": "List team projects", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z", "organization_permission": "write", "private": false, "permissions": { "read": true, "write": true, "admin": false } } ], "schema": { "type": "array", "items": { "title": "Team Project", "description": "A team's access to a project.", "type": "object", "properties": { "owner_url": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "columns_url": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "body": { "type": [ "string", "null" ] }, "number": { "type": "integer" }, "state": { "type": "string" }, "creator": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "organization_permission": { "description": "The organization permission for this project. Only present when owner is an organization.", "type": "string" }, "private": { "description": "Whether the project is private or not. Only present when owner is an organization.", "type": "boolean" }, "permissions": { "type": "object", "properties": { "read": { "type": "boolean" }, "write": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "read", "write", "admin" ] } }, "required": [ "owner_url", "url", "html_url", "columns_url", "id", "node_id", "name", "body", "number", "state", "creator", "created_at", "updated_at", "permissions" ] } } } } ], "previews": [], "descriptionHTML": "Lists the organization projects for a team.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.
OK
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "title": "Check team permissions for a project", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "project_id": "PROJECT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z", "organization_permission": "write", "private": false, "permissions": { "read": true, "write": true, "admin": false } }, "schema": { "title": "Team Project", "description": "A team's access to a project.", "type": "object", "properties": { "owner_url": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "columns_url": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "body": { "type": [ "string", "null" ] }, "number": { "type": "integer" }, "state": { "type": "string" }, "creator": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "organization_permission": { "description": "The organization permission for this project. Only present when owner is an organization.", "type": "string" }, "private": { "description": "Whether the project is private or not. Only present when owner is an organization.", "type": "boolean" }, "permissions": { "type": "object", "properties": { "read": { "type": "boolean" }, "write": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "read", "write", "admin" ] } }, "required": [ "owner_url", "url", "html_url", "columns_url", "id", "node_id", "name", "body", "number", "state", "creator", "created_at", "updated_at", "permissions" ] } } } ], "previews": [], "descriptionHTML": "Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.
OK
" }, { "httpStatusCode": "404", "description": "Not Found if project is not managed by this team
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "title": "Add or update team project permissions", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "permission", "in": "body", "description": "The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"
Response
" } } ], "previews": [], "descriptionHTML": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden if the project is not owned by the organization
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "title": "Remove a project from a team", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "project_id": "PROJECT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.
Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}.
No Content
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/repos", "title": "List team repositories", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": null } ], "schema": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists a team's repositories visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
OK
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "title": "Check team permissions for a repository", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "alternative-response-with-repository-permissions", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Alternative response with repository permissions
", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "maintain": false, "push": false, "triage": false, "pull": true }, "role_name": "read", "allow_rebase_merge": true, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "pull": true, "triage": false, "push": false, "maintain": false, "admin": false }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 }, "schema": { "title": "Team Repository", "description": "A team's access to a repository.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "role_name": { "type": "string", "examples": [ "admin" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "default": false, "type": "boolean", "examples": [ false ] }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean", "examples": [ false ] }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Alternative response with repository permissions
" }, { "httpStatusCode": "204", "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header.
" }, { "httpStatusCode": "404", "description": "Not Found if team does not have permission for the repository
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "title": "Add or update team repository permissions", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "permission", "in": "body", "description": "The permission to grant the team on this repository. We accept the following permissions to be set: pull, triage, push, maintain, admin and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.
Response
" } } ], "previews": [], "descriptionHTML": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "title": "Remove a repository from a team", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
No Content
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/teams", "title": "List child teams", "category": "teams", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "if child teams exist
", "example": [ { "id": 2, "node_id": "MDQ6VGVhbTI=", "url": "https://api.github.com/teams/2", "name": "Original Roster", "slug": "original-roster", "description": "Started it all.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/2/members{/member}", "repositories_url": "https://api.github.com/teams/2/repos", "parent": { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" }, "html_url": "https://github.com/orgs/rails/teams/core" } ], "schema": { "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } } } } ], "previews": [], "descriptionHTML": "Lists the child teams of the team specified by {team_slug}.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
if child teams exist
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}", "title": "Get a team (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "is_verified": true, "has_organization_projects": true, "has_repository_projects": true, "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "html_url": "https://github.com/octocat", "created_at": "2008-01-14T04:33:35Z", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } }, "schema": { "title": "Full Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Developers" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great team." ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "enum": [ "closed", "secret" ], "examples": [ "closed" ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "push" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] }, "members_count": { "type": "integer", "examples": [ 3 ] }, "repos_count": { "type": "integer", "examples": [ 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-08-17T12:37:15Z" ] }, "organization": { "title": "Team Organization", "description": "Team Organization", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] }, "name": { "type": "string", "examples": [ "github" ] }, "company": { "type": "string", "examples": [ "GitHub" ] }, "blog": { "type": "string", "format": "uri", "examples": [ "https://github.com/blog" ] }, "location": { "type": "string", "examples": [ "San Francisco" ] }, "email": { "type": "string", "format": "email", "examples": [ "octocat@github.com" ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "github" ] }, "is_verified": { "type": "boolean", "examples": [ true ] }, "has_organization_projects": { "type": "boolean", "examples": [ true ] }, "has_repository_projects": { "type": "boolean", "examples": [ true ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "type": { "type": "string", "examples": [ "Organization" ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "private_gists": { "type": [ "integer", "null" ], "examples": [ 81 ] }, "disk_usage": { "type": [ "integer", "null" ], "examples": [ 10000 ] }, "collaborators": { "type": [ "integer", "null" ], "examples": [ 8 ] }, "billing_email": { "type": [ "string", "null" ], "format": "email", "examples": [ "org@example.com" ] }, "plan": { "type": "object", "properties": { "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" }, "filled_seats": { "type": "integer" }, "seats": { "type": "integer" } }, "required": [ "name", "space", "private_repos" ] }, "default_repository_permission": { "type": [ "string", "null" ] }, "members_can_create_repositories": { "type": [ "boolean", "null" ], "examples": [ true ] }, "two_factor_requirement_enabled": { "type": [ "boolean", "null" ], "examples": [ true ] }, "members_allowed_repository_creation_type": { "type": "string", "examples": [ "all" ] }, "members_can_create_public_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_internal_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_public_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_pages": { "type": "boolean", "examples": [ true ] }, "members_can_fork_private_repositories": { "type": [ "boolean", "null" ], "examples": [ false ] }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description", "html_url", "has_organization_projects", "has_repository_projects", "public_repos", "public_gists", "followers", "following", "type", "created_at", "updated_at" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "created_at", "updated_at", "members_count", "repos_count", "organization" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/teams/{team_id}", "title": "Update a team (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The name of the team.
", "isRequired": true }, { "type": "string", "name": "description", "in": "body", "description": "The description of the team.
" }, { "type": "string", "name": "privacy", "in": "body", "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
Deprecated. The permission that new repositories will be added to the team with when none is specified.
", "enum": [ "pull", "push", "admin" ], "default": "pull" }, { "type": "integer or null", "name": "parent_team_id", "in": "body", "description": "The ID of a team to set as the parent team.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", "description": "new team description", "privacy": "closed" }, "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response when the updated information already exists
", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "is_verified": true, "has_organization_projects": true, "has_repository_projects": true, "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "html_url": "https://github.com/octocat", "created_at": "2008-01-14T04:33:35Z", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } }, "schema": { "title": "Full Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Developers" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great team." ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "enum": [ "closed", "secret" ], "examples": [ "closed" ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "push" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] }, "members_count": { "type": "integer", "examples": [ 3 ] }, "repos_count": { "type": "integer", "examples": [ 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-08-17T12:37:15Z" ] }, "organization": { "title": "Team Organization", "description": "Team Organization", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] }, "name": { "type": "string", "examples": [ "github" ] }, "company": { "type": "string", "examples": [ "GitHub" ] }, "blog": { "type": "string", "format": "uri", "examples": [ "https://github.com/blog" ] }, "location": { "type": "string", "examples": [ "San Francisco" ] }, "email": { "type": "string", "format": "email", "examples": [ "octocat@github.com" ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "github" ] }, "is_verified": { "type": "boolean", "examples": [ true ] }, "has_organization_projects": { "type": "boolean", "examples": [ true ] }, "has_repository_projects": { "type": "boolean", "examples": [ true ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "type": { "type": "string", "examples": [ "Organization" ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "private_gists": { "type": [ "integer", "null" ], "examples": [ 81 ] }, "disk_usage": { "type": [ "integer", "null" ], "examples": [ 10000 ] }, "collaborators": { "type": [ "integer", "null" ], "examples": [ 8 ] }, "billing_email": { "type": [ "string", "null" ], "format": "email", "examples": [ "org@example.com" ] }, "plan": { "type": "object", "properties": { "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" }, "filled_seats": { "type": "integer" }, "seats": { "type": "integer" } }, "required": [ "name", "space", "private_repos" ] }, "default_repository_permission": { "type": [ "string", "null" ] }, "members_can_create_repositories": { "type": [ "boolean", "null" ], "examples": [ true ] }, "two_factor_requirement_enabled": { "type": [ "boolean", "null" ], "examples": [ true ] }, "members_allowed_repository_creation_type": { "type": "string", "examples": [ "all" ] }, "members_can_create_public_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_internal_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_public_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_pages": { "type": "boolean", "examples": [ true ] }, "members_can_fork_private_repositories": { "type": [ "boolean", "null" ], "examples": [ false ] }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description", "html_url", "has_organization_projects", "has_repository_projects", "public_repos", "public_gists", "followers", "following", "type", "created_at", "updated_at" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "created_at", "updated_at", "members_count", "repos_count", "organization" ] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", "description": "new team description", "privacy": "closed" }, "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "is_verified": true, "has_organization_projects": true, "has_repository_projects": true, "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "html_url": "https://github.com/octocat", "created_at": "2008-01-14T04:33:35Z", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } }, "schema": { "title": "Full Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Developers" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great team." ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "enum": [ "closed", "secret" ], "examples": [ "closed" ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "push" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] }, "members_count": { "type": "integer", "examples": [ 3 ] }, "repos_count": { "type": "integer", "examples": [ 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-08-17T12:37:15Z" ] }, "organization": { "title": "Team Organization", "description": "Team Organization", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] }, "name": { "type": "string", "examples": [ "github" ] }, "company": { "type": "string", "examples": [ "GitHub" ] }, "blog": { "type": "string", "format": "uri", "examples": [ "https://github.com/blog" ] }, "location": { "type": "string", "examples": [ "San Francisco" ] }, "email": { "type": "string", "format": "email", "examples": [ "octocat@github.com" ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "github" ] }, "is_verified": { "type": "boolean", "examples": [ true ] }, "has_organization_projects": { "type": "boolean", "examples": [ true ] }, "has_repository_projects": { "type": "boolean", "examples": [ true ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "type": { "type": "string", "examples": [ "Organization" ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "private_gists": { "type": [ "integer", "null" ], "examples": [ 81 ] }, "disk_usage": { "type": [ "integer", "null" ], "examples": [ 10000 ] }, "collaborators": { "type": [ "integer", "null" ], "examples": [ 8 ] }, "billing_email": { "type": [ "string", "null" ], "format": "email", "examples": [ "org@example.com" ] }, "plan": { "type": "object", "properties": { "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" }, "filled_seats": { "type": "integer" }, "seats": { "type": "integer" } }, "required": [ "name", "space", "private_repos" ] }, "default_repository_permission": { "type": [ "string", "null" ] }, "members_can_create_repositories": { "type": [ "boolean", "null" ], "examples": [ true ] }, "two_factor_requirement_enabled": { "type": [ "boolean", "null" ], "examples": [ true ] }, "members_allowed_repository_creation_type": { "type": "string", "examples": [ "all" ] }, "members_can_create_public_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_internal_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_public_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_pages": { "type": "boolean", "examples": [ true ] }, "members_can_fork_private_repositories": { "type": [ "boolean", "null" ], "examples": [ false ] }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description", "html_url", "has_organization_projects", "has_repository_projects", "public_repos", "public_gists", "followers", "following", "type", "created_at", "updated_at" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "created_at", "updated_at", "members_count", "repos_count", "organization" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: With nested teams, the privacy for parent teams cannot be secret.
Response when the updated information already exists
" }, { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}", "title": "Delete a team (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/projects", "title": "List team projects (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z", "organization_permission": "write", "private": false, "permissions": { "read": true, "write": true, "admin": false } } ], "schema": { "type": "array", "items": { "title": "Team Project", "description": "A team's access to a project.", "type": "object", "properties": { "owner_url": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "columns_url": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "body": { "type": [ "string", "null" ] }, "number": { "type": "integer" }, "state": { "type": "string" }, "creator": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "organization_permission": { "description": "The organization permission for this project. Only present when owner is an organization.", "type": "string" }, "private": { "description": "Whether the project is private or not. Only present when owner is an organization.", "type": "boolean" }, "permissions": { "type": "object", "properties": { "read": { "type": "boolean" }, "write": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "read", "write", "admin" ] } }, "required": [ "owner_url", "url", "html_url", "columns_url", "id", "node_id", "name", "body", "number", "state", "creator", "created_at", "updated_at", "permissions" ] } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.
Lists the organization projects for a team.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/projects/{project_id}", "title": "Check team permissions for a project (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "project_id": "PROJECT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z", "organization_permission": "write", "private": false, "permissions": { "read": true, "write": true, "admin": false } }, "schema": { "title": "Team Project", "description": "A team's access to a project.", "type": "object", "properties": { "owner_url": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "columns_url": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "body": { "type": [ "string", "null" ] }, "number": { "type": "integer" }, "state": { "type": "string" }, "creator": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "organization_permission": { "description": "The organization permission for this project. Only present when owner is an organization.", "type": "string" }, "private": { "description": "Whether the project is private or not. Only present when owner is an organization.", "type": "boolean" }, "permissions": { "type": "object", "properties": { "read": { "type": "boolean" }, "write": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "read", "write", "admin" ] } }, "required": [ "owner_url", "url", "html_url", "columns_url", "id", "node_id", "name", "body", "number", "state", "creator", "created_at", "updated_at", "permissions" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
OK
" }, { "httpStatusCode": "404", "description": "Not Found if project is not managed by this team
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/teams/{team_id}/projects/{project_id}", "title": "Add or update team project permissions (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "permission", "in": "body", "description": "The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"
Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden if the project is not owned by the organization
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}/projects/{project_id}", "title": "Remove a project from a team (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "project_id", "description": "The unique identifier of the project.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "project_id": "PROJECT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.
\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. Note: This endpoint removes the project from the team, but does not delete it.
No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/repos", "title": "List team repositories (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": null } ], "schema": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1296269 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": [ "admin" ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": [ "contributor_covenant" ] }, "name": { "type": "string", "examples": [ "Contributor Covenant" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" ] }, "html_url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [ 0 ] }, "open_issues": { "type": "integer", "examples": [ 0 ] }, "watchers": { "type": "integer", "examples": [ 0 ] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", "title": "Check team permissions for a repository (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "alternative-response-with-extra-repository-information", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Alternative response with extra repository information
", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": false, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "maintain": false, "push": false, "triage": false, "pull": true }, "role_name": "read", "allow_rebase_merge": true, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "pull": true, "triage": false, "push": false, "maintain": false, "admin": false }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 }, "schema": { "title": "Team Repository", "description": "A team's access to a repository.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "role_name": { "type": "string", "examples": [ "admin" ] }, "owner": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "anyOf": [ { "type": "null" }, { "title": "Repository", "description": "A git repository", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "description": "The name of the repository.", "type": "string", "examples": [ "Team Environment" ] }, "full_name": { "type": "string", "examples": [ "octocat/Hello-World" ] }, "license": { "anyOf": [ { "type": "null" }, { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": [ "mit" ] }, "name": { "type": "string", "examples": [ "MIT License" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://api.github.com/licenses/mit" ] }, "spdx_id": { "type": [ "string", "null" ], "examples": [ "MIT" ] }, "node_id": { "type": "string", "examples": [ "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } ] }, "organization": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" ], "examples": [ "This your first repo!" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": [ "git:github.com/octocat/Hello-World.git" ] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" ] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": [ "https://github.com/octocat/Hello-World.git" ] }, "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": [ "https://svn.github.com/octocat/Hello-World" ] }, "homepage": { "type": [ "string", "null" ], "format": "uri", "examples": [ "https://github.com" ] }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer", "examples": [ 9 ] }, "stargazers_count": { "type": "integer", "examples": [ 80 ] }, "watchers_count": { "type": "integer", "examples": [ 80 ] }, "size": { "type": "integer", "examples": [ 108 ] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": [ "master" ] }, "open_issues_count": { "type": "integer", "examples": [ 0 ] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [ true ] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [ true ] }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "template_repository": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string" }, "gravatar_id": { "type": "string" }, "url": { "type": "string" }, "html_url": { "type": "string" }, "followers_url": { "type": "string" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string" }, "organizations_url": { "type": "string" }, "repos_url": { "type": "string" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" } } }, "private": { "type": "boolean" }, "html_url": { "type": "string" }, "description": { "type": "string" }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string" }, "deployments_url": { "type": "string" }, "downloads_url": { "type": "string" }, "events_url": { "type": "string" }, "forks_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string" }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "tags_url": { "type": "string" }, "teams_url": { "type": "string" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string" }, "hooks_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string" }, "language": { "type": "string" }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "allow_rebase_merge": { "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "type": "boolean" }, "allow_auto_merge": { "type": "boolean" }, "delete_branch_on_merge": { "type": "boolean" }, "allow_update_branch": { "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean" }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" } } }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "examples": [ false ] }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:42Z\"" ] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } ] }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [ false ] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [ false ] }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [ true ] }, "allow_forking": { "description": "Whether to allow forking this repo", "default": false, "type": "boolean", "examples": [ false ] }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean", "examples": [ false ] }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } } } ], "previews": [], "descriptionHTML": "Note: Repositories inherited through a parent team will also be checked.
\nDeprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Alternative response with extra repository information
" }, { "httpStatusCode": "204", "description": "Response if repository is managed by this team
" }, { "httpStatusCode": "404", "description": "Not Found if repository is not managed by this team
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", "title": "Add or update team repository permissions (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "permission", "in": "body", "description": "The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.
Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", "title": "Remove a repository from a team (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/teams", "title": "List child teams (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "if child teams exist
", "example": [ { "id": 2, "node_id": "MDQ6VGVhbTI=", "url": "https://api.github.com/teams/2", "name": "Original Roster", "slug": "original-roster", "description": "Started it all.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/2/members{/member}", "repositories_url": "https://api.github.com/teams/2/repos", "parent": { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" }, "html_url": "https://github.com/orgs/rails/teams/core" } ], "schema": { "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
if child teams exist
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/teams", "title": "List teams for the authenticated user", "category": "teams", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "is_verified": true, "has_organization_projects": true, "has_repository_projects": true, "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "html_url": "https://github.com/octocat", "created_at": "2008-01-14T04:33:35Z", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } } ], "schema": { "type": "array", "items": { "title": "Full Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 42 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Developers" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great team." ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "enum": [ "closed", "secret" ], "examples": [ "closed" ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "push" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "parent": { "anyOf": [ { "type": "null" }, { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VGVhbTE=" ] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": [ "Justice League" ] }, "description": { "description": "Description of the team", "type": [ "string", "null" ], "examples": [ "A great team." ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ "admin" ] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": [ "closed" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/rails/teams/core" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/1/repos" ] }, "slug": { "type": "string", "examples": [ "justice-league" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] } ] }, "members_count": { "type": "integer", "examples": [ 3 ] }, "repos_count": { "type": "integer", "examples": [ 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2017-08-17T12:37:15Z" ] }, "organization": { "title": "Team Organization", "description": "Team Organization", "type": "object", "properties": { "login": { "type": "string", "examples": [ "github" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/repos" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/orgs/github/events" ] }, "hooks_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/hooks" ] }, "issues_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/issues" ] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/members{/member}" ] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "description": { "type": [ "string", "null" ], "examples": [ "A great organization" ] }, "name": { "type": "string", "examples": [ "github" ] }, "company": { "type": "string", "examples": [ "GitHub" ] }, "blog": { "type": "string", "format": "uri", "examples": [ "https://github.com/blog" ] }, "location": { "type": "string", "examples": [ "San Francisco" ] }, "email": { "type": "string", "format": "email", "examples": [ "octocat@github.com" ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "github" ] }, "is_verified": { "type": "boolean", "examples": [ true ] }, "has_organization_projects": { "type": "boolean", "examples": [ true ] }, "has_repository_projects": { "type": "boolean", "examples": [ true ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "type": { "type": "string", "examples": [ "Organization" ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "private_gists": { "type": [ "integer", "null" ], "examples": [ 81 ] }, "disk_usage": { "type": [ "integer", "null" ], "examples": [ 10000 ] }, "collaborators": { "type": [ "integer", "null" ], "examples": [ 8 ] }, "billing_email": { "type": [ "string", "null" ], "format": "email", "examples": [ "org@example.com" ] }, "plan": { "type": "object", "properties": { "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" }, "filled_seats": { "type": "integer" }, "seats": { "type": "integer" } }, "required": [ "name", "space", "private_repos" ] }, "default_repository_permission": { "type": [ "string", "null" ] }, "members_can_create_repositories": { "type": [ "boolean", "null" ], "examples": [ true ] }, "two_factor_requirement_enabled": { "type": [ "boolean", "null" ], "examples": [ true ] }, "members_allowed_repository_creation_type": { "type": "string", "examples": [ "all" ] }, "members_can_create_public_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_internal_repositories": { "type": "boolean", "examples": [ true ] }, "members_can_create_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_public_pages": { "type": "boolean", "examples": [ true ] }, "members_can_create_private_pages": { "type": "boolean", "examples": [ true ] }, "members_can_fork_private_repositories": { "type": [ "boolean", "null" ], "examples": [ false ] }, "web_commit_signoff_required": { "type": "boolean", "examples": [ false ] }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description", "html_url", "has_organization_projects", "has_repository_projects", "public_repos", "public_gists", "followers", "following", "type", "created_at", "updated_at" ] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "created_at", "updated_at", "members_count", "repos_count", "organization" ] } } } } ], "previews": [], "descriptionHTML": "List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user, repo, or read:org scope when authenticating via OAuth.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "teams" } ], "discussion-comments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "title": "List discussion comments", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "direction", "description": "The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Do you like apples?", "body_html": "Do you like apples?
", "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": null, "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-15T23:53:58Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } ], "schema": { "type": "array", "items": { "title": "Team Discussion Comment", "description": "A reply to a discussion within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the comment.", "type": "string", "examples": [ "I agree with this suggestion." ] }, "body_html": { "type": "string", "examples": [ "Do you like apples?
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "discussion_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" ] }, "node_id": { "type": "string", "examples": [ "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" ] }, "number": { "description": "The unique sequence number of a team discussion comment.", "type": "integer", "examples": [ 42 ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "created_at", "last_edited_at", "discussion_url", "html_url", "node_id", "number", "updated_at", "url" ] } } } } ], "previews": [], "descriptionHTML": "List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "title": "Create a discussion comment", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The discussion comment's body text.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Do you like apples?", "body_html": "Do you like apples?
", "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": null, "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-15T23:53:58Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } }, "schema": { "title": "Team Discussion Comment", "description": "A reply to a discussion within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the comment.", "type": "string", "examples": [ "I agree with this suggestion." ] }, "body_html": { "type": "string", "examples": [ "Do you like apples?
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "discussion_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" ] }, "node_id": { "type": "string", "examples": [ "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" ] }, "number": { "description": "The unique sequence number of a team discussion comment.", "type": "integer", "examples": [ 42 ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "created_at", "last_edited_at", "discussion_url", "html_url", "node_id", "number", "updated_at", "url" ] } } } ], "previews": [], "descriptionHTML": "Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "title": "Get a discussion comment", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "comment_number", "description": "The number that identifies the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Do you like apples?", "body_html": "Do you like apples?
", "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": null, "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-15T23:53:58Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } }, "schema": { "title": "Team Discussion Comment", "description": "A reply to a discussion within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the comment.", "type": "string", "examples": [ "I agree with this suggestion." ] }, "body_html": { "type": "string", "examples": [ "Do you like apples?
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "discussion_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" ] }, "node_id": { "type": "string", "examples": [ "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" ] }, "number": { "description": "The unique sequence number of a team discussion comment.", "type": "integer", "examples": [ 42 ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "created_at", "last_edited_at", "discussion_url", "html_url", "node_id", "number", "updated_at", "url" ] } } } ], "previews": [], "descriptionHTML": "Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "title": "Update a discussion comment", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "comment_number", "description": "The number that identifies the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The discussion comment's body text.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Do you like pineapples?", "body_html": "Do you like pineapples?
", "body_version": "e6907b24d9c93cc0c5024a7af5888116", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": "2018-01-26T18:22:20Z", "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-26T18:22:20Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } }, "schema": { "title": "Team Discussion Comment", "description": "A reply to a discussion within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the comment.", "type": "string", "examples": [ "I agree with this suggestion." ] }, "body_html": { "type": "string", "examples": [ "Do you like apples?
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "discussion_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" ] }, "node_id": { "type": "string", "examples": [ "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" ] }, "number": { "description": "The unique sequence number of a team discussion comment.", "type": "integer", "examples": [ 42 ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "created_at", "last_edited_at", "discussion_url", "html_url", "node_id", "number", "updated_at", "url" ] } } } ], "previews": [], "descriptionHTML": "Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "title": "Delete a discussion comment", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "comment_number", "description": "The number that identifies the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", "title": "List discussion comments (Legacy)", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "direction", "description": "The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Do you like apples?", "body_html": "Do you like apples?
", "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": null, "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-15T23:53:58Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } ], "schema": { "type": "array", "items": { "title": "Team Discussion Comment", "description": "A reply to a discussion within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the comment.", "type": "string", "examples": [ "I agree with this suggestion." ] }, "body_html": { "type": "string", "examples": [ "Do you like apples?
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "discussion_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" ] }, "node_id": { "type": "string", "examples": [ "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" ] }, "number": { "description": "The unique sequence number of a team discussion comment.", "type": "integer", "examples": [ 42 ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "created_at", "last_edited_at", "discussion_url", "html_url", "node_id", "number", "updated_at", "url" ] } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion. OAuth access tokens require the read:discussion scope.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", "title": "Create a discussion comment (Legacy)", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The discussion comment's body text.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" }, "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Do you like apples?", "body_html": "Do you like apples?
", "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": null, "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-15T23:53:58Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } }, "schema": { "title": "Team Discussion Comment", "description": "A reply to a discussion within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the comment.", "type": "string", "examples": [ "I agree with this suggestion." ] }, "body_html": { "type": "string", "examples": [ "Do you like apples?
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "discussion_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" ] }, "node_id": { "type": "string", "examples": [ "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" ] }, "number": { "description": "The unique sequence number of a team discussion comment.", "type": "integer", "examples": [ 42 ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "created_at", "last_edited_at", "discussion_url", "html_url", "node_id", "number", "updated_at", "url" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "title": "Get a discussion comment (Legacy)", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "comment_number", "description": "The number that identifies the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Do you like apples?", "body_html": "Do you like apples?
", "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": null, "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-15T23:53:58Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } }, "schema": { "title": "Team Discussion Comment", "description": "A reply to a discussion within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the comment.", "type": "string", "examples": [ "I agree with this suggestion." ] }, "body_html": { "type": "string", "examples": [ "Do you like apples?
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "discussion_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" ] }, "node_id": { "type": "string", "examples": [ "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" ] }, "number": { "description": "The unique sequence number of a team discussion comment.", "type": "integer", "examples": [ 42 ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "created_at", "last_edited_at", "discussion_url", "html_url", "node_id", "number", "updated_at", "url" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "title": "Update a discussion comment (Legacy)", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "comment_number", "description": "The number that identifies the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "body", "in": "body", "description": "The discussion comment's body text.
", "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" }, "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Do you like pineapples?", "body_html": "Do you like pineapples?
", "body_version": "e6907b24d9c93cc0c5024a7af5888116", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": "2018-01-26T18:22:20Z", "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-26T18:22:20Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } }, "schema": { "title": "Team Discussion Comment", "description": "A reply to a discussion within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the comment.", "type": "string", "examples": [ "I agree with this suggestion." ] }, "body_html": { "type": "string", "examples": [ "Do you like apples?
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "discussion_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" ] }, "node_id": { "type": "string", "examples": [ "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" ] }, "number": { "description": "The unique sequence number of a team discussion comment.", "type": "integer", "examples": [ 42 ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-15T23:53:58Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "created_at", "last_edited_at", "discussion_url", "html_url", "node_id", "number", "updated_at", "url" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "title": "Delete a discussion comment (Legacy)", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "comment_number", "description": "The number that identifies the comment.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
No Content
" } ] } ], "discussions": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", "title": "List discussions", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "direction", "description": "The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "pinned", "in": "query", "required": false, "description": "Pinned discussions only filter
", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 0, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": null, "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Our first team post", "updated_at": "2018-01-25T18:56:31Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } ], "schema": { "type": "array", "items": { "title": "Team Discussion", "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the discussion.", "type": "string", "examples": [ "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ "Hi! This is an area for us to collaborate as a team
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "comments_count": { "type": "integer", "examples": [ 0 ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, "pinned": { "description": "Whether or not this discussion should be pinned for easy retrieval.", "type": "boolean", "examples": [ true ] }, "private": { "description": "Whether or not this discussion should be restricted to team members and organization administrators.", "type": "boolean", "examples": [ true ] }, "team_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027" ] }, "title": { "description": "The title of the discussion.", "type": "string", "examples": [ "How can we improve our workflow?" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "comments_count", "comments_url", "created_at", "last_edited_at", "html_url", "pinned", "private", "node_id", "number", "team_url", "title", "updated_at", "url" ] } } } } ], "previews": [], "descriptionHTML": "List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", "title": "Create a discussion", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "title", "in": "body", "description": "The discussion post's title.
", "isRequired": true }, { "type": "string", "name": "body", "in": "body", "description": "The discussion post's body text.
", "isRequired": true }, { "type": "boolean", "name": "private", "in": "body", "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.
Response
", "example": { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 0, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": null, "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Our first team post", "updated_at": "2018-01-25T18:56:31Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } }, "schema": { "title": "Team Discussion", "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the discussion.", "type": "string", "examples": [ "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ "Hi! This is an area for us to collaborate as a team
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "comments_count": { "type": "integer", "examples": [ 0 ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, "pinned": { "description": "Whether or not this discussion should be pinned for easy retrieval.", "type": "boolean", "examples": [ true ] }, "private": { "description": "Whether or not this discussion should be restricted to team members and organization administrators.", "type": "boolean", "examples": [ true ] }, "team_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027" ] }, "title": { "description": "The title of the discussion.", "type": "string", "examples": [ "How can we improve our workflow?" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "comments_count", "comments_url", "created_at", "last_edited_at", "html_url", "pinned", "private", "node_id", "number", "team_url", "title", "updated_at", "url" ] } } } ], "previews": [], "descriptionHTML": "Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "title": "Get a discussion", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 0, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": null, "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Our first team post", "updated_at": "2018-01-25T18:56:31Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } }, "schema": { "title": "Team Discussion", "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the discussion.", "type": "string", "examples": [ "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ "Hi! This is an area for us to collaborate as a team
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "comments_count": { "type": "integer", "examples": [ 0 ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, "pinned": { "description": "Whether or not this discussion should be pinned for easy retrieval.", "type": "boolean", "examples": [ true ] }, "private": { "description": "Whether or not this discussion should be restricted to team members and organization administrators.", "type": "boolean", "examples": [ true ] }, "team_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027" ] }, "title": { "description": "The title of the discussion.", "type": "string", "examples": [ "How can we improve our workflow?" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "comments_count", "comments_url", "created_at", "last_edited_at", "html_url", "pinned", "private", "node_id", "number", "team_url", "title", "updated_at", "url" ] } } } ], "previews": [], "descriptionHTML": "Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "title": "Update a discussion", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "title", "in": "body", "description": "The discussion post's title.
" }, { "type": "string", "name": "body", "in": "body", "description": "The discussion post's body text.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 1, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": "2018-01-26T18:22:20Z", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Welcome to our first team post", "updated_at": "2018-01-26T18:22:20Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } }, "schema": { "title": "Team Discussion", "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the discussion.", "type": "string", "examples": [ "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ "Hi! This is an area for us to collaborate as a team
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "comments_count": { "type": "integer", "examples": [ 0 ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, "pinned": { "description": "Whether or not this discussion should be pinned for easy retrieval.", "type": "boolean", "examples": [ true ] }, "private": { "description": "Whether or not this discussion should be restricted to team members and organization administrators.", "type": "boolean", "examples": [ true ] }, "team_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027" ] }, "title": { "description": "The title of the discussion.", "type": "string", "examples": [ "How can we improve our workflow?" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "comments_count", "comments_url", "created_at", "last_edited_at", "html_url", "pinned", "private", "node_id", "number", "team_url", "title", "updated_at", "url" ] } } } ], "previews": [], "descriptionHTML": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "title": "Delete a discussion", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/discussions", "title": "List discussions (Legacy)", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "direction", "description": "The direction to sort the results by.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 0, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": null, "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Our first team post", "updated_at": "2018-01-25T18:56:31Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } ], "schema": { "type": "array", "items": { "title": "Team Discussion", "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the discussion.", "type": "string", "examples": [ "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ "Hi! This is an area for us to collaborate as a team
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "comments_count": { "type": "integer", "examples": [ 0 ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, "pinned": { "description": "Whether or not this discussion should be pinned for easy retrieval.", "type": "boolean", "examples": [ true ] }, "private": { "description": "Whether or not this discussion should be restricted to team members and organization administrators.", "type": "boolean", "examples": [ true ] }, "team_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027" ] }, "title": { "description": "The title of the discussion.", "type": "string", "examples": [ "How can we improve our workflow?" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "comments_count", "comments_url", "created_at", "last_edited_at", "html_url", "pinned", "private", "node_id", "number", "team_url", "title", "updated_at", "url" ] } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/teams/{team_id}/discussions", "title": "Create a discussion (Legacy)", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "title", "in": "body", "description": "The discussion post's title.
", "isRequired": true }, { "type": "string", "name": "body", "in": "body", "description": "The discussion post's body text.
", "isRequired": true }, { "type": "boolean", "name": "private", "in": "body", "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.
Response
", "example": { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 0, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": null, "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Our first team post", "updated_at": "2018-01-25T18:56:31Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } }, "schema": { "title": "Team Discussion", "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the discussion.", "type": "string", "examples": [ "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ "Hi! This is an area for us to collaborate as a team
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "comments_count": { "type": "integer", "examples": [ 0 ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, "pinned": { "description": "Whether or not this discussion should be pinned for easy retrieval.", "type": "boolean", "examples": [ true ] }, "private": { "description": "Whether or not this discussion should be restricted to team members and organization administrators.", "type": "boolean", "examples": [ true ] }, "team_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027" ] }, "title": { "description": "The title of the discussion.", "type": "string", "examples": [ "How can we improve our workflow?" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "comments_count", "comments_url", "created_at", "last_edited_at", "html_url", "pinned", "private", "node_id", "number", "team_url", "title", "updated_at", "url" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", "title": "Get a discussion (Legacy)", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 0, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": null, "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Our first team post", "updated_at": "2018-01-25T18:56:31Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } }, "schema": { "title": "Team Discussion", "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the discussion.", "type": "string", "examples": [ "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ "Hi! This is an area for us to collaborate as a team
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "comments_count": { "type": "integer", "examples": [ 0 ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, "pinned": { "description": "Whether or not this discussion should be pinned for easy retrieval.", "type": "boolean", "examples": [ true ] }, "private": { "description": "Whether or not this discussion should be restricted to team members and organization administrators.", "type": "boolean", "examples": [ true ] }, "team_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027" ] }, "title": { "description": "The title of the discussion.", "type": "string", "examples": [ "How can we improve our workflow?" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "comments_count", "comments_url", "created_at", "last_edited_at", "html_url", "pinned", "private", "node_id", "number", "team_url", "title", "updated_at", "url" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", "title": "Update a discussion (Legacy)", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "title", "in": "body", "description": "The discussion post's title.
" }, { "type": "string", "name": "body", "in": "body", "description": "The discussion post's body text.
" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" }, "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 1, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": "2018-01-26T18:22:20Z", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Welcome to our first team post", "updated_at": "2018-01-26T18:22:20Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } }, "schema": { "title": "Team Discussion", "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { "author": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] }, "body": { "description": "The main text of the discussion.", "type": "string", "examples": [ "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ "Hi! This is an area for us to collaborate as a team
" ] }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ "0307116bbf7ced493b8d8a346c650b71" ] }, "comments_count": { "type": "integer", "examples": [ 0 ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "last_edited_at": { "type": [ "string", "null" ], "format": "date-time" }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, "pinned": { "description": "Whether or not this discussion should be pinned for easy retrieval.", "type": "boolean", "examples": [ true ] }, "private": { "description": "Whether or not this discussion should be restricted to team members and organization administrators.", "type": "boolean", "examples": [ true ] }, "team_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027" ] }, "title": { "description": "The title of the discussion.", "type": "string", "examples": [ "How can we improve our workflow?" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "author", "body", "body_html", "body_version", "comments_count", "comments_url", "created_at", "last_edited_at", "html_url", "pinned", "private", "node_id", "number", "team_url", "title", "updated_at", "url" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", "title": "Delete a discussion (Legacy)", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "discussion_number", "description": "The number that identifies the discussion.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
No Content
" } ] } ], "external-groups": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/external-group/{group_id}", "title": "Get an external group", "category": "teams", "subcategory": "external-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "group_id", "description": "The unique identifier of the group.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "group_id": "GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "group_id": "123", "group_name": "Octocat admins", "updated_at": "2021-01-24T11:31:04-06:00", "teams": [ { "team_id": 1, "team_name": "team-test" }, { "team_id": 2, "team_name": "team-test2" } ], "members": [ { "member_id": 1, "member_login": "mona-lisa_eocsaxrs", "member_name": "Mona Lisa", "member_email": "mona_lisa@github.com" }, { "member_id": 2, "member_login": "octo-lisa_eocsaxrs", "member_name": "Octo Lisa", "member_email": "octo_lisa@github.com" } ] }, "schema": { "title": "ExternalGroup", "description": "Information about an external group's usage and its members", "type": "object", "required": [ "group_id", "group_name", "teams", "members" ], "properties": { "group_id": { "description": "The internal ID of the group", "type": "integer", "examples": [ 1 ] }, "group_name": { "description": "The display name for the group", "type": "string", "examples": [ "group-azuread-test" ] }, "updated_at": { "description": "The date when the group was last updated_at", "type": "string", "examples": [ "2021-01-03 22:27:15:000 -700" ] }, "teams": { "description": "An array of teams linked to this group", "type": "array", "items": { "type": "object", "required": [ "team_id", "team_name" ], "properties": { "team_id": { "description": "The id for a team", "type": "integer", "examples": [ 1 ] }, "team_name": { "description": "The name of the team", "type": "string", "examples": [ "team-test" ] } } }, "examples": [ { "team_id": 1, "team_name": "team-test" }, { "team_id": 2, "team_name": "team-test2" } ] }, "members": { "description": "An array of external members linked to this group", "type": "array", "items": { "type": "object", "required": [ "member_id", "member_login", "member_name", "member_email" ], "properties": { "member_id": { "description": "The internal user ID of the identity", "type": "integer", "examples": [ 1 ] }, "member_login": { "description": "The handle/login for the user", "type": "string", "examples": [ "mona-lisa_eocsaxrs" ] }, "member_name": { "description": "The user display name/profile name", "type": "string", "examples": [ "Mona Lisa" ] }, "member_email": { "description": "An email attached to a user", "type": "string", "examples": [ "mona_lisa@github.com" ] } } }, "examples": [ { "member_id": 1, "member_login": "mona-lisa_eocsaxrs", "member_name": "Mona Lisa", "member_email": "mona_lisa@github.com" }, { "member_id": 2, "member_login": "octo-lisa_eocsaxrs", "member_name": "Octo Lisa", "member_email": "octo_lisa@github.com" } ] } } } } } ], "previews": [], "descriptionHTML": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/external-groups", "title": "List external groups in an organization", "category": "teams", "subcategory": "external-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page token
", "in": "query", "schema": { "type": "integer" } }, { "name": "display_name", "description": "Limits the list to groups containing the text in the group name
", "in": "query", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "updated_at": "2021-01-24T11:31:04-06:00" }, { "group_id": "456", "group_name": "Octocat docs members", "updated_at": "2021-03-24T11:31:04-06:00" } ] }, "schema": { "title": "ExternalGroups", "description": "A list of external groups available to be connected to a team", "type": "object", "properties": { "groups": { "description": "An array of external groups available to be mapped to a team", "type": "array", "items": { "type": "object", "required": [ "group_id", "group_name", "updated_at" ], "properties": { "group_id": { "description": "The internal ID of the group", "type": "integer", "examples": [ 1 ] }, "group_name": { "description": "The display name of the group", "type": "string", "examples": [ "group-azuread-test" ] }, "updated_at": { "description": "The time of the last update for this group", "type": "string", "examples": [ "2019-06-03 22:27:15:000 -700" ] } } }, "examples": [ { "group_id": 1, "group_name": "group-azuread-test", "updated_at": "2021-01-03 22:27:15:000 -700" }, { "group_id": 2, "group_name": "group-azuread-test2", "updated_at": "2021-06-03 22:27:15:000 -700" } ] } } } } } ], "previews": [], "descriptionHTML": "Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", "title": "List a connection between an external group and a team", "category": "teams", "subcategory": "external-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "updated_at": "2021-01-24T11:31:04-06:00" }, { "group_id": "456", "group_name": "Octocat docs members", "updated_at": "2021-03-24T11:31:04-06:00" } ] }, "schema": { "title": "ExternalGroups", "description": "A list of external groups available to be connected to a team", "type": "object", "properties": { "groups": { "description": "An array of external groups available to be mapped to a team", "type": "array", "items": { "type": "object", "required": [ "group_id", "group_name", "updated_at" ], "properties": { "group_id": { "description": "The internal ID of the group", "type": "integer", "examples": [ 1 ] }, "group_name": { "description": "The display name of the group", "type": "string", "examples": [ "group-azuread-test" ] }, "updated_at": { "description": "The time of the last update for this group", "type": "string", "examples": [ "2019-06-03 22:27:15:000 -700" ] } } }, "examples": [ { "group_id": 1, "group_name": "group-azuread-test", "updated_at": "2021-01-03 22:27:15:000 -700" }, { "group_id": 2, "group_name": "group-azuread-test2", "updated_at": "2021-06-03 22:27:15:000 -700" } ] } } } } } ], "previews": [], "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", "title": "Update the connection between an external group and a team", "category": "teams", "subcategory": "external-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "integer", "name": "group_id", "in": "body", "description": "External Group Id
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "group_id": 123 }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "group_id": "123", "group_name": "Octocat admins", "updated_at": "2021-01-24T11:31:04-06:00", "teams": [ { "team_id": 1, "team_name": "team-test" }, { "team_id": 2, "team_name": "team-test2" } ], "members": [ { "member_id": 1, "member_login": "mona-lisa_eocsaxrs", "member_name": "Mona Lisa", "member_email": "mona_lisa@github.com" }, { "member_id": 2, "member_login": "octo-lisa_eocsaxrs", "member_name": "Octo Lisa", "member_email": "octo_lisa@github.com" } ] }, "schema": { "title": "ExternalGroup", "description": "Information about an external group's usage and its members", "type": "object", "required": [ "group_id", "group_name", "teams", "members" ], "properties": { "group_id": { "description": "The internal ID of the group", "type": "integer", "examples": [ 1 ] }, "group_name": { "description": "The display name for the group", "type": "string", "examples": [ "group-azuread-test" ] }, "updated_at": { "description": "The date when the group was last updated_at", "type": "string", "examples": [ "2021-01-03 22:27:15:000 -700" ] }, "teams": { "description": "An array of teams linked to this group", "type": "array", "items": { "type": "object", "required": [ "team_id", "team_name" ], "properties": { "team_id": { "description": "The id for a team", "type": "integer", "examples": [ 1 ] }, "team_name": { "description": "The name of the team", "type": "string", "examples": [ "team-test" ] } } }, "examples": [ { "team_id": 1, "team_name": "team-test" }, { "team_id": 2, "team_name": "team-test2" } ] }, "members": { "description": "An array of external members linked to this group", "type": "array", "items": { "type": "object", "required": [ "member_id", "member_login", "member_name", "member_email" ], "properties": { "member_id": { "description": "The internal user ID of the identity", "type": "integer", "examples": [ 1 ] }, "member_login": { "description": "The handle/login for the user", "type": "string", "examples": [ "mona-lisa_eocsaxrs" ] }, "member_name": { "description": "The user display name/profile name", "type": "string", "examples": [ "Mona Lisa" ] }, "member_email": { "description": "An email attached to a user", "type": "string", "examples": [ "mona_lisa@github.com" ] } } }, "examples": [ { "member_id": 1, "member_login": "mona-lisa_eocsaxrs", "member_name": "Mona Lisa", "member_email": "mona_lisa@github.com" }, { "member_id": 2, "member_login": "octo-lisa_eocsaxrs", "member_name": "Octo Lisa", "member_email": "octo_lisa@github.com" } ] } } } } } ], "previews": [], "descriptionHTML": "Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", "title": "Remove the connection between an external group and a team", "category": "teams", "subcategory": "external-groups", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a connection between a team and an external group.
\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ], "members": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/invitations", "title": "List pending team invitations", "category": "teams", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "login": "monalisa", "node_id": "MDQ6VXNlcjE=", "email": "octocat@github.com", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", "failed_at": "", "failed_reason": "", "inviter": { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, "team_count": 2, "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams" } ], "schema": { "type": "array", "items": { "title": "Organization Invitation", "description": "Organization Invitation", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "role": { "type": "string" }, "created_at": { "type": "string" }, "failed_at": { "type": [ "string", "null" ] }, "failed_reason": { "type": [ "string", "null" ] }, "inviter": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "team_count": { "type": "integer" }, "node_id": { "type": "string", "examples": [ "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" ] }, "invitation_teams_url": { "type": "string", "examples": [ "\"https://api.github.com/organizations/16/invitations/1/teams\"" ] } }, "required": [ "id", "login", "email", "role", "created_at", "inviter", "team_count", "invitation_teams_url", "node_id" ] } } } } ], "previews": [], "descriptionHTML": "The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/invitations.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/members", "title": "List team members", "category": "teams", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "description": "Filters members returned by their role in the team.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "member", "maintainer", "all" ], "default": "all" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Team members will include the members of child teams.
\nTo list members in a team, the team must be visible to the authenticated user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "title": "Get team membership for a user", "category": "teams", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if user is a team maintainer
", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", "state": "active" }, "schema": { "title": "Team Membership", "description": "Team Membership", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "role": { "description": "The role of the user in the team.", "enum": [ "member", "maintainer" ], "default": "member", "type": "string", "examples": [ "member" ] }, "state": { "description": "The state of the user's membership in the team.", "type": "string", "enum": [ "active", "pending" ] } }, "required": [ "role", "state", "url" ] } } } ], "previews": [], "descriptionHTML": "Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.
OK
" }, { "httpStatusCode": "404", "description": "if user has no team membership
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "title": "Add or update team membership for a user", "category": "teams", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "role", "in": "body", "description": "The role that this user should have in the team.
", "enum": [ "member", "maintainer" ], "default": "member" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Add or update team membership for an organization member", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "role": "maintainer" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if user's membership with team is now pending
", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", "state": "pending" }, "schema": { "title": "Team Membership", "description": "Team Membership", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "role": { "description": "The role of the user in the team.", "enum": [ "member", "maintainer" ], "default": "member", "type": "string", "examples": [ "member" ] }, "state": { "description": "The state of the user's membership in the team.", "type": "string", "enum": [ "active", "pending" ] } }, "required": [ "role", "state", "url" ] } } } ], "previews": [], "descriptionHTML": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
OK
" }, { "httpStatusCode": "403", "description": "Forbidden if team synchronization is set up
" }, { "httpStatusCode": "422", "description": "Unprocessable Entity if you attempt to add an organization to a team
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "title": "Remove team membership for a user", "category": "teams", "subcategory": "members", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nNote: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden if team synchronization is set up
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/invitations", "title": "List pending team invitations (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "login": "monalisa", "node_id": "MDQ6VXNlcjE=", "email": "octocat@github.com", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", "failed_at": "", "failed_reason": "", "inviter": { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, "team_count": 2, "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams" } ], "schema": { "type": "array", "items": { "title": "Organization Invitation", "description": "Organization Invitation", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "role": { "type": "string" }, "created_at": { "type": "string" }, "failed_at": { "type": [ "string", "null" ] }, "failed_reason": { "type": [ "string", "null" ] }, "inviter": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "team_count": { "type": "integer" }, "node_id": { "type": "string", "examples": [ "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" ] }, "invitation_teams_url": { "type": "string", "examples": [ "\"https://api.github.com/organizations/16/invitations/1/teams\"" ] } }, "required": [ "id", "login", "email", "role", "created_at", "inviter", "team_count", "invitation_teams_url", "node_id" ] } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations endpoint.
The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/members", "title": "List team members (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "role", "description": "Filters members returned by their role in the team.
", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "member", "maintainer", "all" ], "default": "all" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/members/{username}", "title": "Get team member (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "if user is a member
" } } ], "previews": [], "descriptionHTML": "The \"Get team member\" endpoint (described below) is deprecated.
\nWe recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.
\nTo list members in a team, the team must be visible to the authenticated user.
", "statusCodes": [ { "httpStatusCode": "204", "description": "if user is a member
" }, { "httpStatusCode": "404", "description": "if user is not a member
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/teams/{team_id}/members/{username}", "title": "Add team member (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "The \"Add team member\" endpoint (described below) is deprecated.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Not Found if team synchronization is set up
" }, { "httpStatusCode": "422", "description": "Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}/members/{username}", "title": "Remove team member (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "The \"Remove team member\" endpoint (described below) is deprecated.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Not Found if team synchronization is setup
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/memberships/{username}", "title": "Get team membership for a user (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if user is a team maintainer
", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", "state": "active" }, "schema": { "title": "Team Membership", "description": "Team Membership", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "role": { "description": "The role of the user in the team.", "enum": [ "member", "maintainer" ], "default": "member", "type": "string", "examples": [ "member" ] }, "state": { "description": "The state of the user's membership in the team.", "type": "string", "enum": [ "active", "pending" ] } }, "required": [ "role", "state", "url" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/teams/{team_id}/memberships/{username}", "title": "Add or update team membership for a user (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "role", "in": "body", "description": "The role that this user should have in the team.
", "enum": [ "member", "maintainer" ], "default": "member" } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Assign the member role for a user in a team", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "role": "member" }, "parameters": { "team_id": "TEAM_ID", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if user's membership with team is now pending
", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", "state": "pending" }, "schema": { "title": "Team Membership", "description": "Team Membership", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "role": { "description": "The role of the user in the team.", "enum": [ "member", "maintainer" ], "default": "member", "type": "string", "examples": [ "member" ] }, "state": { "description": "The state of the user's membership in the team.", "type": "string", "enum": [ "active", "pending" ] } }, "required": [ "role", "state", "url" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden if team synchronization is set up
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Unprocessable Entity if you attempt to add an organization to a team
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}/memberships/{username}", "title": "Remove team membership for a user (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "403", "description": "if team synchronization is set up
" } ] } ], "team-sync": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/team-sync/groups", "title": "List IdP groups for an organization", "category": "teams", "subcategory": "team-sync", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page token
", "in": "query", "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "group_description": "The people who configure your octoworld." }, { "group_id": "456", "group_name": "Octocat docs members", "group_description": "The people who make your octoworld come to life." } ] }, "schema": { "title": "GroupMapping", "description": "External Groups to be mapped to a team for membership", "type": "object", "properties": { "groups": { "description": "Array of groups to be mapped to this team", "type": "array", "items": { "type": "object", "required": [ "group_id", "group_name", "group_description" ], "properties": { "group_id": { "description": "The ID of the group", "type": "string", "examples": [ "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa" ] }, "group_name": { "description": "The name of the group", "type": "string", "examples": [ "saml-azuread-test" ] }, "group_description": { "description": "a description of the group", "type": "string", "examples": [ "A group of Developers working on AzureAD SAML SSO" ] }, "status": { "description": "synchronization status for this group mapping", "type": "string", "examples": [ "unsynced" ] }, "synced_at": { "description": "the time of the last sync for this group-mapping", "type": [ "string", "null" ], "examples": [ "2019-06-03 22:27:15:000 -700" ] } } }, "examples": [ { "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", "group_name": "saml-azuread-test", "group_description": "A group of Developers working on AzureAD SAML SSO" }, { "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", "group_name": "saml-azuread-test2", "group_description": "Another group of Developers working on AzureAD SAML SSO" } ] } } } } } ], "previews": [], "descriptionHTML": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nList IdP groups available in an organization. You can limit your page results using the per_page parameter. GitHub generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings", "title": "List IdP groups for a team", "category": "teams", "subcategory": "team-sync", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "group_description": "The people who configure your octoworld." }, { "group_id": "456", "group_name": "Octocat docs members", "group_description": "The people who make your octoworld come to life." } ] }, "schema": { "title": "GroupMapping", "description": "External Groups to be mapped to a team for membership", "type": "object", "properties": { "groups": { "description": "Array of groups to be mapped to this team", "type": "array", "items": { "type": "object", "required": [ "group_id", "group_name", "group_description" ], "properties": { "group_id": { "description": "The ID of the group", "type": "string", "examples": [ "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa" ] }, "group_name": { "description": "The name of the group", "type": "string", "examples": [ "saml-azuread-test" ] }, "group_description": { "description": "a description of the group", "type": "string", "examples": [ "A group of Developers working on AzureAD SAML SSO" ] }, "status": { "description": "synchronization status for this group mapping", "type": "string", "examples": [ "unsynced" ] }, "synced_at": { "description": "the time of the last sync for this group-mapping", "type": [ "string", "null" ], "examples": [ "2019-06-03 22:27:15:000 -700" ] } } }, "examples": [ { "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", "group_name": "saml-azuread-test", "group_description": "A group of Developers working on AzureAD SAML SSO" }, { "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", "group_name": "saml-azuread-test2", "group_description": "Another group of Developers working on AzureAD SAML SSO" } ] } } } } } ], "previews": [], "descriptionHTML": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nList IdP groups connected to a team on GitHub.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings", "title": "Create or update IdP group connections", "category": "teams", "subcategory": "team-sync", "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "array of objects", "name": "groups", "in": "body", "description": "The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.
ID of the IdP group.
", "isRequired": true }, { "type": "string", "name": "group_name", "description": "Name of the IdP group.
", "isRequired": true }, { "type": "string", "name": "group_description", "description": "Description of the IdP group.
", "isRequired": true } ] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "group_description": "string" } ] }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "group_description": "The people who configure your octoworld." }, { "group_id": "456", "group_name": "Octocat docs members", "group_description": "The people who make your octoworld come to life." } ] }, "schema": { "title": "GroupMapping", "description": "External Groups to be mapped to a team for membership", "type": "object", "properties": { "groups": { "description": "Array of groups to be mapped to this team", "type": "array", "items": { "type": "object", "required": [ "group_id", "group_name", "group_description" ], "properties": { "group_id": { "description": "The ID of the group", "type": "string", "examples": [ "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa" ] }, "group_name": { "description": "The name of the group", "type": "string", "examples": [ "saml-azuread-test" ] }, "group_description": { "description": "a description of the group", "type": "string", "examples": [ "A group of Developers working on AzureAD SAML SSO" ] }, "status": { "description": "synchronization status for this group mapping", "type": "string", "examples": [ "unsynced" ] }, "synced_at": { "description": "the time of the last sync for this group-mapping", "type": [ "string", "null" ], "examples": [ "2019-06-03 22:27:15:000 -700" ] } } }, "examples": [ { "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", "group_name": "saml-azuread-test", "group_description": "A group of Developers working on AzureAD SAML SSO" }, { "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", "group_name": "saml-azuread-test2", "group_description": "Another group of Developers working on AzureAD SAML SSO" } ] } } } } } ], "previews": [], "descriptionHTML": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/team-sync/group-mappings", "title": "List IdP groups for a team (Legacy)", "category": "teams", "subcategory": "team-sync", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "group_description": "The people who configure your octoworld." }, { "group_id": "456", "group_name": "Octocat docs members", "group_description": "The people who make your octoworld come to life." } ] }, "schema": { "title": "GroupMapping", "description": "External Groups to be mapped to a team for membership", "type": "object", "properties": { "groups": { "description": "Array of groups to be mapped to this team", "type": "array", "items": { "type": "object", "required": [ "group_id", "group_name", "group_description" ], "properties": { "group_id": { "description": "The ID of the group", "type": "string", "examples": [ "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa" ] }, "group_name": { "description": "The name of the group", "type": "string", "examples": [ "saml-azuread-test" ] }, "group_description": { "description": "a description of the group", "type": "string", "examples": [ "A group of Developers working on AzureAD SAML SSO" ] }, "status": { "description": "synchronization status for this group mapping", "type": "string", "examples": [ "unsynced" ] }, "synced_at": { "description": "the time of the last sync for this group-mapping", "type": [ "string", "null" ], "examples": [ "2019-06-03 22:27:15:000 -700" ] } } }, "examples": [ { "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", "group_name": "saml-azuread-test", "group_description": "A group of Developers working on AzureAD SAML SSO" }, { "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", "group_name": "saml-azuread-test2", "group_description": "Another group of Developers working on AzureAD SAML SSO" } ] } } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List IdP groups for a team endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nList IdP groups connected to a team on GitHub.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/teams/{team_id}/team-sync/group-mappings", "title": "Create or update IdP group connections (Legacy)", "category": "teams", "subcategory": "team-sync", "parameters": [ { "name": "team_id", "description": "The unique identifier of the team.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "array of objects", "name": "groups", "in": "body", "description": "The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.
ID of the IdP group.
", "isRequired": true }, { "type": "string", "name": "group_name", "description": "Name of the IdP group.
", "isRequired": true }, { "type": "string", "name": "group_description", "description": "Description of the IdP group.
", "isRequired": true }, { "type": "string", "name": "id", "description": "" }, { "type": "string", "name": "name", "description": "" }, { "type": "string", "name": "description", "description": "" } ] }, { "type": "string", "name": "synced_at", "in": "body", "description": "" } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "description": "The people who configure your octoworld.", "group_description": "string" } ] }, "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "group_description": "The people who configure your octoworld." } ] }, "schema": { "title": "GroupMapping", "description": "External Groups to be mapped to a team for membership", "type": "object", "properties": { "groups": { "description": "Array of groups to be mapped to this team", "type": "array", "items": { "type": "object", "required": [ "group_id", "group_name", "group_description" ], "properties": { "group_id": { "description": "The ID of the group", "type": "string", "examples": [ "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa" ] }, "group_name": { "description": "The name of the group", "type": "string", "examples": [ "saml-azuread-test" ] }, "group_description": { "description": "a description of the group", "type": "string", "examples": [ "A group of Developers working on AzureAD SAML SSO" ] }, "status": { "description": "synchronization status for this group mapping", "type": "string", "examples": [ "unsynced" ] }, "synced_at": { "description": "the time of the last sync for this group-mapping", "type": [ "string", "null" ], "examples": [ "2019-06-03 22:27:15:000 -700" ] } } }, "examples": [ { "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", "group_name": "saml-azuread-test", "group_description": "A group of Developers working on AzureAD SAML SSO" }, { "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", "group_name": "saml-azuread-test2", "group_description": "Another group of Developers working on AzureAD SAML SSO" } ] } } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create or update IdP group connections endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.
OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ] }, "users": { "users": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user", "title": "Get the authenticated user", "category": "users", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "response-with-public-and-private-profile-information", "request": { "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response with public and private profile information
", "example": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false, "name": "monalisa octocat", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "hireable": false, "bio": "There once was...", "twitter_username": "monatheoctocat", "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "created_at": "2008-01-14T04:33:35Z", "updated_at": "2008-01-14T04:33:35Z", "private_gists": 81, "total_private_repos": 100, "owned_private_repos": 100, "disk_usage": 10000, "collaborators": 8, "two_factor_authentication": true, "plan": { "name": "Medium", "space": 400, "private_repos": 20, "collaborators": 0 } }, "schema": { "oneOf": [ { "title": "Private User", "description": "Private User", "type": "object", "properties": { "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ], "examples": [ "monalisa octocat" ] }, "company": { "type": [ "string", "null" ], "examples": [ "GitHub" ] }, "blog": { "type": [ "string", "null" ], "examples": [ "https://github.com/blog" ] }, "location": { "type": [ "string", "null" ], "examples": [ "San Francisco" ] }, "email": { "type": [ "string", "null" ], "format": "email", "examples": [ "octocat@github.com" ] }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ], "examples": [ "There once was..." ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "monalisa" ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "private_gists": { "type": "integer", "examples": [ 81 ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "disk_usage": { "type": "integer", "examples": [ 10000 ] }, "collaborators": { "type": "integer", "examples": [ 8 ] }, "two_factor_authentication": { "type": "boolean", "examples": [ true ] }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "business_plus": { "type": "boolean" }, "ldap_dn": { "type": "string" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at", "collaborators", "disk_usage", "owned_private_repos", "private_gists", "total_private_repos", "two_factor_authentication" ] }, { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "company": { "type": [ "string", "null" ] }, "blog": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ] }, "twitter_username": { "type": [ "string", "null" ] }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "private_gists": { "type": "integer", "examples": [ 1 ] }, "total_private_repos": { "type": "integer", "examples": [ 2 ] }, "owned_private_repos": { "type": "integer", "examples": [ 2 ] }, "disk_usage": { "type": "integer", "examples": [ 1 ] }, "collaborators": { "type": "integer", "examples": [ 3 ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false } ] } } }, { "key": "response-with-public-profile-information", "request": { "description": "Example 2: Status Code 200", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response with public profile information
", "example": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false, "name": "monalisa octocat", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "hireable": false, "bio": "There once was...", "twitter_username": "monatheoctocat", "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "created_at": "2008-01-14T04:33:35Z", "updated_at": "2008-01-14T04:33:35Z" }, "schema": { "oneOf": [ { "title": "Private User", "description": "Private User", "type": "object", "properties": { "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ], "examples": [ "monalisa octocat" ] }, "company": { "type": [ "string", "null" ], "examples": [ "GitHub" ] }, "blog": { "type": [ "string", "null" ], "examples": [ "https://github.com/blog" ] }, "location": { "type": [ "string", "null" ], "examples": [ "San Francisco" ] }, "email": { "type": [ "string", "null" ], "format": "email", "examples": [ "octocat@github.com" ] }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ], "examples": [ "There once was..." ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "monalisa" ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "private_gists": { "type": "integer", "examples": [ 81 ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "disk_usage": { "type": "integer", "examples": [ 10000 ] }, "collaborators": { "type": "integer", "examples": [ 8 ] }, "two_factor_authentication": { "type": "boolean", "examples": [ true ] }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "business_plus": { "type": "boolean" }, "ldap_dn": { "type": "string" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at", "collaborators", "disk_usage", "owned_private_repos", "private_gists", "total_private_repos", "two_factor_authentication" ] }, { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "company": { "type": [ "string", "null" ] }, "blog": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ] }, "twitter_username": { "type": [ "string", "null" ] }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "private_gists": { "type": "integer", "examples": [ 1 ] }, "total_private_repos": { "type": "integer", "examples": [ 2 ] }, "owned_private_repos": { "type": "integer", "examples": [ 2 ] }, "disk_usage": { "type": "integer", "examples": [ 1 ] }, "collaborators": { "type": "integer", "examples": [ 3 ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false } ] } } } ], "previews": [], "descriptionHTML": "If the authenticated user is authenticated through basic authentication or OAuth with the user scope, then the response lists public and private profile information.
If the authenticated user is authenticated through OAuth without the user scope, then the response lists only public profile information.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "users" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/user", "title": "Update the authenticated user", "category": "users", "parameters": [], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "The new name of the user.
" }, { "type": "string", "name": "email", "in": "body", "description": "The publicly visible email address of the user.
" }, { "type": "string", "name": "blog", "in": "body", "description": "The new blog URL of the user.
" }, { "type": "string or null", "name": "twitter_username", "in": "body", "description": "The new Twitter username of the user.
" }, { "type": "string", "name": "company", "in": "body", "description": "The new company of the user.
" }, { "type": "string", "name": "location", "in": "body", "description": "The new location of the user.
" }, { "type": "boolean", "name": "hireable", "in": "body", "description": "The new hiring availability of the user.
" }, { "type": "string", "name": "bio", "in": "body", "description": "The new short biography of the user.
" } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false, "name": "monalisa octocat", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "hireable": false, "bio": "There once was...", "twitter_username": "monatheoctocat", "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "created_at": "2008-01-14T04:33:35Z", "updated_at": "2008-01-14T04:33:35Z", "private_gists": 81, "total_private_repos": 100, "owned_private_repos": 100, "disk_usage": 10000, "collaborators": 8, "two_factor_authentication": true, "plan": { "name": "Medium", "space": 400, "private_repos": 20, "collaborators": 0 } }, "schema": { "title": "Private User", "description": "Private User", "type": "object", "properties": { "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ], "examples": [ "monalisa octocat" ] }, "company": { "type": [ "string", "null" ], "examples": [ "GitHub" ] }, "blog": { "type": [ "string", "null" ], "examples": [ "https://github.com/blog" ] }, "location": { "type": [ "string", "null" ], "examples": [ "San Francisco" ] }, "email": { "type": [ "string", "null" ], "format": "email", "examples": [ "octocat@github.com" ] }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ], "examples": [ "There once was..." ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "monalisa" ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "private_gists": { "type": "integer", "examples": [ 81 ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "disk_usage": { "type": "integer", "examples": [ 10000 ] }, "collaborators": { "type": "integer", "examples": [ 8 ] }, "two_factor_authentication": { "type": "boolean", "examples": [ true ] }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "business_plus": { "type": "boolean" }, "ldap_dn": { "type": "string" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at", "collaborators", "disk_usage", "owned_private_repos", "private_gists", "total_private_repos", "two_factor_authentication" ] } } } ], "previews": [], "descriptionHTML": "Note: If your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "users" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users", "title": "List users", "category": "users", "parameters": [ { "name": "since", "description": "A user ID. Only return users with an ID greater than this ID.
", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "users" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}", "title": "Get a user", "category": "users", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default-response", "request": { "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Default response
", "example": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false, "name": "monalisa octocat", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "hireable": false, "bio": "There once was...", "twitter_username": "monatheoctocat", "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "created_at": "2008-01-14T04:33:35Z", "updated_at": "2008-01-14T04:33:35Z" }, "schema": { "oneOf": [ { "title": "Private User", "description": "Private User", "type": "object", "properties": { "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ], "examples": [ "monalisa octocat" ] }, "company": { "type": [ "string", "null" ], "examples": [ "GitHub" ] }, "blog": { "type": [ "string", "null" ], "examples": [ "https://github.com/blog" ] }, "location": { "type": [ "string", "null" ], "examples": [ "San Francisco" ] }, "email": { "type": [ "string", "null" ], "format": "email", "examples": [ "octocat@github.com" ] }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ], "examples": [ "There once was..." ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "monalisa" ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "private_gists": { "type": "integer", "examples": [ 81 ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "disk_usage": { "type": "integer", "examples": [ 10000 ] }, "collaborators": { "type": "integer", "examples": [ 8 ] }, "two_factor_authentication": { "type": "boolean", "examples": [ true ] }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "business_plus": { "type": "boolean" }, "ldap_dn": { "type": "string" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at", "collaborators", "disk_usage", "owned_private_repos", "private_gists", "total_private_repos", "two_factor_authentication" ] }, { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "company": { "type": [ "string", "null" ] }, "blog": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ] }, "twitter_username": { "type": [ "string", "null" ] }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "private_gists": { "type": "integer", "examples": [ 1 ] }, "total_private_repos": { "type": "integer", "examples": [ 2 ] }, "owned_private_repos": { "type": "integer", "examples": [ 2 ] }, "disk_usage": { "type": "integer", "examples": [ 1 ] }, "collaborators": { "type": "integer", "examples": [ 3 ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false } ] } } }, { "key": "response-with-git-hub-plan-information", "request": { "description": "Example 2: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response with GitHub plan information
", "example": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false, "name": "monalisa octocat", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "hireable": false, "bio": "There once was...", "twitter_username": "monatheoctocat", "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "created_at": "2008-01-14T04:33:35Z", "updated_at": "2008-01-14T04:33:35Z", "plan": { "name": "pro", "space": 976562499, "collaborators": 0, "private_repos": 9999 } }, "schema": { "oneOf": [ { "title": "Private User", "description": "Private User", "type": "object", "properties": { "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ], "examples": [ "monalisa octocat" ] }, "company": { "type": [ "string", "null" ], "examples": [ "GitHub" ] }, "blog": { "type": [ "string", "null" ], "examples": [ "https://github.com/blog" ] }, "location": { "type": [ "string", "null" ], "examples": [ "San Francisco" ] }, "email": { "type": [ "string", "null" ], "format": "email", "examples": [ "octocat@github.com" ] }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ], "examples": [ "There once was..." ] }, "twitter_username": { "type": [ "string", "null" ], "examples": [ "monalisa" ] }, "public_repos": { "type": "integer", "examples": [ 2 ] }, "public_gists": { "type": "integer", "examples": [ 1 ] }, "followers": { "type": "integer", "examples": [ 20 ] }, "following": { "type": "integer", "examples": [ 0 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2008-01-14T04:33:35Z" ] }, "private_gists": { "type": "integer", "examples": [ 81 ] }, "total_private_repos": { "type": "integer", "examples": [ 100 ] }, "owned_private_repos": { "type": "integer", "examples": [ 100 ] }, "disk_usage": { "type": "integer", "examples": [ 10000 ] }, "collaborators": { "type": "integer", "examples": [ 8 ] }, "two_factor_authentication": { "type": "boolean", "examples": [ true ] }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "business_plus": { "type": "boolean" }, "ldap_dn": { "type": "string" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at", "collaborators", "disk_usage", "owned_private_repos", "private_gists", "total_private_repos", "two_factor_authentication" ] }, { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "company": { "type": [ "string", "null" ] }, "blog": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "hireable": { "type": [ "boolean", "null" ] }, "bio": { "type": [ "string", "null" ] }, "twitter_username": { "type": [ "string", "null" ] }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": [ "string", "null" ], "format": "date-time" }, "private_gists": { "type": "integer", "examples": [ 1 ] }, "total_private_repos": { "type": "integer", "examples": [ 2 ] }, "owned_private_repos": { "type": "integer", "examples": [ 2 ] }, "disk_usage": { "type": "integer", "examples": [ 1 ] }, "collaborators": { "type": "integer", "examples": [ 3 ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false } ] } } } ], "previews": [], "descriptionHTML": "Provides publicly available information about someone with a GitHub account.
\nGitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See \"Identifying and authorizing users for GitHub Apps\" for details about authentication. For an example response, see 'Response with GitHub plan information' below\"
The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "users" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/hovercard", "title": "Get contextual information for a user", "category": "users", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subject_type", "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.
Uses the ID for the subject_type you specified. Required when using subject_type.
Response
", "example": { "contexts": [ { "message": "Owns this repository", "octicon": "repo" } ] }, "schema": { "title": "Hovercard", "description": "Hovercard", "type": "object", "properties": { "contexts": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" }, "octicon": { "type": "string" } }, "required": [ "message", "octicon" ] } } }, "required": [ "contexts" ] } } } ], "previews": [], "descriptionHTML": "Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:
curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "users" } ], "blocking": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/blocks", "title": "List users blocked by the authenticated user", "category": "users", "subcategory": "blocking", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "List the users you've blocked on your personal account.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/blocks/{username}", "title": "Check if a user is blocked by the authenticated user", "category": "users", "subcategory": "blocking", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "If the user is blocked
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "If the user is blocked
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "If the user is not blocked
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/blocks/{username}", "title": "Block a user", "category": "users", "subcategory": "blocking", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/blocks/{username}", "title": "Unblock a user", "category": "users", "subcategory": "blocking", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "emails": [ { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/user/email/visibility", "title": "Set primary email visibility for the authenticated user", "category": "users", "subcategory": "emails", "parameters": [], "bodyParameters": [ { "type": "string", "name": "visibility", "in": "body", "description": "Denotes whether an email is publicly visible.
", "isRequired": true, "enum": [ "public", "private" ] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example setting the primary email address to private", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "visibility": "private" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "email": "octocat@github.com", "primary": true, "verified": true, "visibility": "private" } ], "schema": { "type": "array", "items": { "title": "Email", "description": "Email", "type": "object", "properties": { "email": { "type": "string", "format": "email", "examples": [ "octocat@github.com" ] }, "primary": { "type": "boolean", "examples": [ true ] }, "verified": { "type": "boolean", "examples": [ true ] }, "visibility": { "type": [ "string", "null" ], "examples": [ "public" ] } }, "required": [ "email", "primary", "verified", "visibility" ] } } } } ], "previews": [], "descriptionHTML": "Sets the visibility for your primary email addresses.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/emails", "title": "List email addresses for the authenticated user", "category": "users", "subcategory": "emails", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "email": "octocat@github.com", "verified": true, "primary": true, "visibility": "public" } ], "schema": { "type": "array", "items": { "title": "Email", "description": "Email", "type": "object", "properties": { "email": { "type": "string", "format": "email", "examples": [ "octocat@github.com" ] }, "primary": { "type": "boolean", "examples": [ true ] }, "verified": { "type": "boolean", "examples": [ true ] }, "visibility": { "type": [ "string", "null" ], "examples": [ "public" ] } }, "required": [ "email", "primary", "verified", "visibility" ] } } } } ], "previews": [], "descriptionHTML": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the user:email scope.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/emails", "title": "Add an email address for the authenticated user", "category": "users", "subcategory": "emails", "parameters": [], "bodyParameters": [ { "type": "array of strings", "name": "emails", "in": "body", "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.
Response
", "example": [ { "email": "octocat@octocat.org", "primary": false, "verified": false, "visibility": "public" }, { "email": "octocat@github.com", "primary": false, "verified": false, "visibility": null }, { "email": "mona@github.com", "primary": false, "verified": false, "visibility": null } ], "schema": { "type": "array", "items": { "title": "Email", "description": "Email", "type": "object", "properties": { "email": { "type": "string", "format": "email", "examples": [ "octocat@github.com" ] }, "primary": { "type": "boolean", "examples": [ true ] }, "verified": { "type": "boolean", "examples": [ true ] }, "visibility": { "type": [ "string", "null" ], "examples": [ "public" ] } }, "required": [ "email", "primary", "verified", "visibility" ] } } } } ], "previews": [], "descriptionHTML": "This endpoint is accessible with the user scope.
Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/emails", "title": "Delete an email address for the authenticated user", "category": "users", "subcategory": "emails", "parameters": [], "bodyParameters": [ { "type": "array of strings", "name": "emails", "in": "body", "description": "Email addresses associated with the GitHub user account.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "contentType": "application/json", "description": "Example deleting multiple email accounts", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "emails": [ "octocat@github.com", "mona@github.com" ] } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "This endpoint is accessible with the user scope.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/public_emails", "title": "List public email addresses for the authenticated user", "category": "users", "subcategory": "emails", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "email": "octocat@github.com", "verified": true, "primary": true, "visibility": "public" } ], "schema": { "type": "array", "items": { "title": "Email", "description": "Email", "type": "object", "properties": { "email": { "type": "string", "format": "email", "examples": [ "octocat@github.com" ] }, "primary": { "type": "boolean", "examples": [ true ] }, "verified": { "type": "boolean", "examples": [ true ] }, "visibility": { "type": [ "string", "null" ], "examples": [ "public" ] } }, "required": [ "email", "primary", "verified", "visibility" ] } } } } ], "previews": [], "descriptionHTML": "Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "followers": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/followers", "title": "List followers of the authenticated user", "category": "users", "subcategory": "followers", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists the people following the authenticated user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/following", "title": "List the people the authenticated user follows", "category": "users", "subcategory": "followers", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists the people who the authenticated user follows.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/following/{username}", "title": "Check if a person is followed by the authenticated user", "category": "users", "subcategory": "followers", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "if the person is followed by the authenticated user
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "if the person is followed by the authenticated user
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "if the person is not followed by the authenticated user
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/following/{username}", "title": "Follow a user", "category": "users", "subcategory": "followers", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/following/{username}", "title": "Unfollow a user", "category": "users", "subcategory": "followers", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/followers", "title": "List followers of a user", "category": "users", "subcategory": "followers", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists the people following the specified user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/following", "title": "List the people a user follows", "category": "users", "subcategory": "followers", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "schema": { "type": "array", "items": { "title": "Simple User", "description": "Simple User", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } } } ], "previews": [], "descriptionHTML": "Lists the people who the specified user follows.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/following/{target_user}", "title": "Check if a user follows another user", "category": "users", "subcategory": "followers", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "target_user", "in": "path", "required": true, "schema": { "type": "string" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", "target_user": "TARGET_USER" } }, "response": { "statusCode": "204", "description": "if the user follows the target user
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "if the user follows the target user
" }, { "httpStatusCode": "404", "description": "if the user does not follow the target user
" } ] } ], "gpg-keys": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/gpg_keys", "title": "List GPG keys for the authenticated user", "category": "users", "subcategory": "gpg-keys", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 3, "name": "Octocat's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", "emails": [ { "email": "octocat@users.noreply.github.com", "verified": true } ], "subkeys": [ { "id": 4, "primary_key_id": 3, "key_id": "4A595D4C72EE49C7", "public_key": "zsBNBFayYZ...", "emails": [], "subkeys": [], "can_sign": false, "can_encrypt_comms": true, "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", "revoked": false } ], "can_sign": true, "can_encrypt_comms": false, "can_encrypt_storage": false, "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", "revoked": false, "raw_key": "string" } ], "schema": { "type": "array", "items": { "title": "GPG Key", "description": "A unique encryption key", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 3 ] }, "name": { "type": [ "string", "null" ], "examples": [ "Octocat's GPG Key" ] }, "primary_key_id": { "type": [ "integer", "null" ] }, "key_id": { "type": "string", "examples": [ "3262EFF25BA0D270" ] }, "public_key": { "type": "string", "examples": [ "xsBNBFayYZ..." ] }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "verified": { "type": "boolean" } } }, "examples": [ { "email": "octocat@users.noreply.github.com", "verified": true } ] }, "subkeys": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "primary_key_id": { "type": "integer" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "emails": { "type": "array", "items": {} }, "subkeys": { "type": "array", "items": {} }, "can_sign": { "type": "boolean" }, "can_encrypt_comms": { "type": "boolean" }, "can_encrypt_storage": { "type": "boolean" }, "can_certify": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": [ "string", "null" ] }, "raw_key": { "type": [ "string", "null" ] }, "revoked": { "type": "boolean" } } }, "examples": [ { "id": 4, "primary_key_id": 3, "key_id": "4A595D4C72EE49C7", "public_key": "zsBNBFayYZ...", "emails": [], "subkeys": [], "can_sign": false, "can_encrypt_comms": true, "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": null, "revoked": false } ] }, "can_sign": { "type": "boolean", "examples": [ true ] }, "can_encrypt_comms": { "type": "boolean" }, "can_encrypt_storage": { "type": "boolean" }, "can_certify": { "type": "boolean", "examples": [ true ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-03-24T11:31:04-06:00" ] }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "revoked": { "type": "boolean", "examples": [ true ] }, "raw_key": { "type": [ "string", "null" ] } }, "required": [ "id", "primary_key_id", "key_id", "raw_key", "public_key", "created_at", "expires_at", "can_sign", "can_encrypt_comms", "can_encrypt_storage", "can_certify", "emails", "subkeys", "revoked" ] } } } } ], "previews": [], "descriptionHTML": "Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/gpg_keys", "title": "Create a GPG key for the authenticated user", "category": "users", "subcategory": "gpg-keys", "parameters": [], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "A descriptive name for the new key.
" }, { "type": "string", "name": "armored_public_key", "in": "body", "description": "A GPG key in ASCII-armored format.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 3, "name": "Octocat's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", "emails": [ { "email": "octocat@users.noreply.github.com", "verified": true } ], "subkeys": [ { "id": 4, "primary_key_id": 3, "key_id": "4A595D4C72EE49C7", "public_key": "zsBNBFayYZ...", "emails": [], "subkeys": [], "can_sign": false, "can_encrypt_comms": true, "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", "revoked": false } ], "can_sign": true, "can_encrypt_comms": false, "can_encrypt_storage": false, "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", "revoked": false, "raw_key": "\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v2\\n\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\nIts/HFYRLiFgDLmTlxo=\\n=+OzK\\n-----END PGP PUBLIC KEY BLOCK-----\"" }, "schema": { "title": "GPG Key", "description": "A unique encryption key", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 3 ] }, "name": { "type": [ "string", "null" ], "examples": [ "Octocat's GPG Key" ] }, "primary_key_id": { "type": [ "integer", "null" ] }, "key_id": { "type": "string", "examples": [ "3262EFF25BA0D270" ] }, "public_key": { "type": "string", "examples": [ "xsBNBFayYZ..." ] }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "verified": { "type": "boolean" } } }, "examples": [ { "email": "octocat@users.noreply.github.com", "verified": true } ] }, "subkeys": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "primary_key_id": { "type": "integer" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "emails": { "type": "array", "items": {} }, "subkeys": { "type": "array", "items": {} }, "can_sign": { "type": "boolean" }, "can_encrypt_comms": { "type": "boolean" }, "can_encrypt_storage": { "type": "boolean" }, "can_certify": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": [ "string", "null" ] }, "raw_key": { "type": [ "string", "null" ] }, "revoked": { "type": "boolean" } } }, "examples": [ { "id": 4, "primary_key_id": 3, "key_id": "4A595D4C72EE49C7", "public_key": "zsBNBFayYZ...", "emails": [], "subkeys": [], "can_sign": false, "can_encrypt_comms": true, "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": null, "revoked": false } ] }, "can_sign": { "type": "boolean", "examples": [ true ] }, "can_encrypt_comms": { "type": "boolean" }, "can_encrypt_storage": { "type": "boolean" }, "can_certify": { "type": "boolean", "examples": [ true ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-03-24T11:31:04-06:00" ] }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "revoked": { "type": "boolean", "examples": [ true ] }, "raw_key": { "type": [ "string", "null" ] } }, "required": [ "id", "primary_key_id", "key_id", "raw_key", "public_key", "created_at", "expires_at", "can_sign", "can_encrypt_comms", "can_encrypt_storage", "can_certify", "emails", "subkeys", "revoked" ] } } } ], "previews": [], "descriptionHTML": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:gpg_key scope.
Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/gpg_keys/{gpg_key_id}", "title": "Get a GPG key for the authenticated user", "category": "users", "subcategory": "gpg-keys", "parameters": [ { "name": "gpg_key_id", "description": "The unique identifier of the GPG key.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 3, "name": "Octocat's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", "emails": [ { "email": "octocat@users.noreply.github.com", "verified": true } ], "subkeys": [ { "id": 4, "primary_key_id": 3, "key_id": "4A595D4C72EE49C7", "public_key": "zsBNBFayYZ...", "emails": [], "subkeys": [], "can_sign": false, "can_encrypt_comms": true, "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", "revoked": false } ], "can_sign": true, "can_encrypt_comms": false, "can_encrypt_storage": false, "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", "revoked": false, "raw_key": "\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v2\\n\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\nIts/HFYRLiFgDLmTlxo=\\n=+OzK\\n-----END PGP PUBLIC KEY BLOCK-----\"" }, "schema": { "title": "GPG Key", "description": "A unique encryption key", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 3 ] }, "name": { "type": [ "string", "null" ], "examples": [ "Octocat's GPG Key" ] }, "primary_key_id": { "type": [ "integer", "null" ] }, "key_id": { "type": "string", "examples": [ "3262EFF25BA0D270" ] }, "public_key": { "type": "string", "examples": [ "xsBNBFayYZ..." ] }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "verified": { "type": "boolean" } } }, "examples": [ { "email": "octocat@users.noreply.github.com", "verified": true } ] }, "subkeys": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "primary_key_id": { "type": "integer" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "emails": { "type": "array", "items": {} }, "subkeys": { "type": "array", "items": {} }, "can_sign": { "type": "boolean" }, "can_encrypt_comms": { "type": "boolean" }, "can_encrypt_storage": { "type": "boolean" }, "can_certify": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": [ "string", "null" ] }, "raw_key": { "type": [ "string", "null" ] }, "revoked": { "type": "boolean" } } }, "examples": [ { "id": 4, "primary_key_id": 3, "key_id": "4A595D4C72EE49C7", "public_key": "zsBNBFayYZ...", "emails": [], "subkeys": [], "can_sign": false, "can_encrypt_comms": true, "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": null, "revoked": false } ] }, "can_sign": { "type": "boolean", "examples": [ true ] }, "can_encrypt_comms": { "type": "boolean" }, "can_encrypt_storage": { "type": "boolean" }, "can_certify": { "type": "boolean", "examples": [ true ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-03-24T11:31:04-06:00" ] }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "revoked": { "type": "boolean", "examples": [ true ] }, "raw_key": { "type": [ "string", "null" ] } }, "required": [ "id", "primary_key_id", "key_id", "raw_key", "public_key", "created_at", "expires_at", "can_sign", "can_encrypt_comms", "can_encrypt_storage", "can_certify", "emails", "subkeys", "revoked" ] } } } ], "previews": [], "descriptionHTML": "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/gpg_keys/{gpg_key_id}", "title": "Delete a GPG key for the authenticated user", "category": "users", "subcategory": "gpg-keys", "parameters": [ { "name": "gpg_key_id", "description": "The unique identifier of the GPG key.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:gpg_key scope.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/gpg_keys", "title": "List GPG keys for a user", "category": "users", "subcategory": "gpg-keys", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 3, "name": "Octocat's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", "emails": [ { "email": "octocat@users.noreply.github.com", "verified": true } ], "subkeys": [ { "id": 4, "primary_key_id": 3, "key_id": "4A595D4C72EE49C7", "public_key": "zsBNBFayYZ...", "emails": [], "subkeys": [], "can_sign": false, "can_encrypt_comms": true, "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", "revoked": false } ], "can_sign": true, "can_encrypt_comms": false, "can_encrypt_storage": false, "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", "revoked": false, "raw_key": "string" } ], "schema": { "type": "array", "items": { "title": "GPG Key", "description": "A unique encryption key", "type": "object", "properties": { "id": { "type": "integer", "examples": [ 3 ] }, "name": { "type": [ "string", "null" ], "examples": [ "Octocat's GPG Key" ] }, "primary_key_id": { "type": [ "integer", "null" ] }, "key_id": { "type": "string", "examples": [ "3262EFF25BA0D270" ] }, "public_key": { "type": "string", "examples": [ "xsBNBFayYZ..." ] }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "verified": { "type": "boolean" } } }, "examples": [ { "email": "octocat@users.noreply.github.com", "verified": true } ] }, "subkeys": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "primary_key_id": { "type": "integer" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "emails": { "type": "array", "items": {} }, "subkeys": { "type": "array", "items": {} }, "can_sign": { "type": "boolean" }, "can_encrypt_comms": { "type": "boolean" }, "can_encrypt_storage": { "type": "boolean" }, "can_certify": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": [ "string", "null" ] }, "raw_key": { "type": [ "string", "null" ] }, "revoked": { "type": "boolean" } } }, "examples": [ { "id": 4, "primary_key_id": 3, "key_id": "4A595D4C72EE49C7", "public_key": "zsBNBFayYZ...", "emails": [], "subkeys": [], "can_sign": false, "can_encrypt_comms": true, "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": null, "revoked": false } ] }, "can_sign": { "type": "boolean", "examples": [ true ] }, "can_encrypt_comms": { "type": "boolean" }, "can_encrypt_storage": { "type": "boolean" }, "can_certify": { "type": "boolean", "examples": [ true ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2016-03-24T11:31:04-06:00" ] }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "revoked": { "type": "boolean", "examples": [ true ] }, "raw_key": { "type": [ "string", "null" ] } }, "required": [ "id", "primary_key_id", "key_id", "raw_key", "public_key", "created_at", "expires_at", "can_sign", "can_encrypt_comms", "can_encrypt_storage", "can_certify", "emails", "subkeys", "revoked" ] } } } } ], "previews": [], "descriptionHTML": "Lists the GPG keys for a user. This information is accessible by anyone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ], "keys": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/keys", "title": "List public SSH keys for the authenticated user", "category": "users", "subcategory": "keys", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, "url": "https://api.github.com/user/keys/2", "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", "created_at": "2020-06-11T21:31:57Z", "verified": false, "read_only": false }, { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", "id": 3, "url": "https://api.github.com/user/keys/3", "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", "created_at": "2020-07-11T21:31:57Z", "verified": false, "read_only": false } ], "schema": { "type": "array", "items": { "title": "Key", "description": "Key", "type": "object", "properties": { "key": { "type": "string" }, "id": { "type": "integer" }, "url": { "type": "string" }, "title": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "read_only": { "type": "boolean" } }, "required": [ "key", "id", "url", "title", "created_at", "verified", "read_only" ] } } } } ], "previews": [], "descriptionHTML": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/keys", "title": "Create a public SSH key for the authenticated user", "category": "users", "subcategory": "keys", "parameters": [], "bodyParameters": [ { "type": "string", "name": "title", "in": "body", "description": "A descriptive name for the new key.
" }, { "type": "string", "name": "key", "in": "body", "description": "The public SSH key to add to your GitHub account.
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, "url": "https://api.github.com/user/keys/2", "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", "created_at": "2020-06-11T21:31:57Z", "verified": false, "read_only": false }, "schema": { "title": "Key", "description": "Key", "type": "object", "properties": { "key": { "type": "string" }, "id": { "type": "integer" }, "url": { "type": "string" }, "title": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "read_only": { "type": "boolean" } }, "required": [ "key", "id", "url", "title", "created_at", "verified", "read_only" ] } } } ], "previews": [], "descriptionHTML": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:public_key scope.
Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/keys/{key_id}", "title": "Get a public SSH key for the authenticated user", "category": "users", "subcategory": "keys", "parameters": [ { "name": "key_id", "description": "The unique identifier of the key.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, "url": "https://api.github.com/user/keys/2", "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", "created_at": "2020-06-11T21:31:57Z", "verified": false, "read_only": false }, "schema": { "title": "Key", "description": "Key", "type": "object", "properties": { "key": { "type": "string" }, "id": { "type": "integer" }, "url": { "type": "string" }, "title": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "read_only": { "type": "boolean" } }, "required": [ "key", "id", "url", "title", "created_at", "verified", "read_only" ] } } } ], "previews": [], "descriptionHTML": "View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/keys/{key_id}", "title": "Delete a public SSH key for the authenticated user", "category": "users", "subcategory": "keys", "parameters": [ { "name": "key_id", "description": "The unique identifier of the key.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/keys", "title": "List public keys for a user", "category": "users", "subcategory": "keys", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "key": "ssh-rsa AAA..." } ], "schema": { "type": "array", "items": { "title": "Key Simple", "description": "Key Simple", "type": "object", "properties": { "id": { "type": "integer" }, "key": { "type": "string" } }, "required": [ "key", "id" ] } } } } ], "previews": [], "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ], "ssh-signing-keys": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/ssh_signing_keys", "title": "List SSH signing keys for the authenticated user", "category": "users", "subcategory": "ssh-signing-keys", "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, "url": "https://api.github.com/user/keys/2", "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", "created_at": "2020-06-11T21:31:57Z" }, { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", "id": 3, "url": "https://api.github.com/user/keys/3", "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", "created_at": "2020-07-11T21:31:57Z" } ], "schema": { "type": "array", "items": { "title": "SSH Signing Key", "description": "A public SSH key used to sign Git commits", "type": "object", "properties": { "key": { "type": "string" }, "id": { "type": "integer" }, "title": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "key", "id", "title", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least read:ssh_signing_key scope. For more information, see \"Understanding scopes for OAuth apps.\"
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/ssh_signing_keys", "title": "Create a SSH signing key for the authenticated user", "category": "users", "subcategory": "ssh-signing-keys", "parameters": [], "bodyParameters": [ { "type": "string", "name": "title", "in": "body", "description": "A descriptive name for the new key.
" }, { "type": "string", "name": "key", "in": "body", "description": "The public SSH key to add to your GitHub account. For more information, see \"Checking for existing SSH keys.\"
", "isRequired": true } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, "url": "https://api.github.com/user/keys/2", "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", "created_at": "2020-06-11T21:31:57Z" }, "schema": { "title": "SSH Signing Key", "description": "A public SSH key used to sign Git commits", "type": "object", "properties": { "key": { "type": "string" }, "id": { "type": "integer" }, "title": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "key", "id", "title", "created_at" ] } } } ], "previews": [], "descriptionHTML": "Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least write:ssh_signing_key scope. For more information, see \"Understanding scopes for OAuth apps.\"
Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}", "title": "Get an SSH signing key for the authenticated user", "category": "users", "subcategory": "ssh-signing-keys", "parameters": [ { "name": "ssh_signing_key_id", "description": "The unique identifier of the SSH signing key.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "ssh_signing_key_id": "SSH_SIGNING_KEY_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, "url": "https://api.github.com/user/keys/2", "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", "created_at": "2020-06-11T21:31:57Z" }, "schema": { "title": "SSH Signing Key", "description": "A public SSH key used to sign Git commits", "type": "object", "properties": { "key": { "type": "string" }, "id": { "type": "integer" }, "title": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "key", "id", "title", "created_at" ] } } } ], "previews": [], "descriptionHTML": "Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least read:ssh_signing_key scope. For more information, see \"Understanding scopes for OAuth apps.\"
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}", "title": "Delete an SSH signing key for the authenticated user", "category": "users", "subcategory": "ssh-signing-keys", "parameters": [ { "name": "ssh_signing_key_id", "description": "The unique identifier of the SSH signing key.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "ssh_signing_key_id": "SSH_SIGNING_KEY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least admin:ssh_signing_key scope. For more information, see \"Understanding scopes for OAuth apps.\"
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/ssh_signing_keys", "title": "List SSH signing keys for a user", "category": "users", "subcategory": "ssh-signing-keys", "parameters": [ { "name": "username", "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, "url": "https://api.github.com/user/keys/2", "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", "created_at": "2020-06-11T21:31:57Z" }, { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", "id": 3, "url": "https://api.github.com/user/keys/3", "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", "created_at": "2020-07-11T21:31:57Z" } ], "schema": { "type": "array", "items": { "title": "SSH Signing Key", "description": "A public SSH key used to sign Git commits", "type": "object", "properties": { "key": { "type": "string" }, "id": { "type": "integer" }, "title": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "key", "id", "title", "created_at" ] } } } } ], "previews": [], "descriptionHTML": "Lists the SSH signing keys for a user. This operation is accessible by anyone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ] }, "webhooks": { "repo-config": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", "title": "Get a webhook configuration for a repository", "category": "webhooks", "subcategory": "repo-config", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" }, "schema": { "title": "Webhook Configuration", "description": "Configuration object of the webhook", "type": "object", "properties": { "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "format": "uri", "examples": [ "https://example.com/webhook" ] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ "\"json\"" ] }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "examples": [ "\"0\"" ] }, { "type": "number" } ] } } } } } ], "previews": [], "descriptionHTML": "Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use \"Get a repository webhook.\"
Access tokens must have the read:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:read permission.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", "title": "Update a webhook configuration for a repository", "category": "webhooks", "subcategory": "repo-config", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "string", "name": "url", "in": "body", "description": "The URL to which the payloads will be delivered.
" }, { "type": "string", "name": "content_type", "in": "body", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
Response
", "example": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" }, "schema": { "title": "Webhook Configuration", "description": "Configuration object of the webhook", "type": "object", "properties": { "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "format": "uri", "examples": [ "https://example.com/webhook" ] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ "\"json\"" ] }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "examples": [ "\"0\"" ] }, { "type": "number" } ] } } } } } ], "previews": [], "descriptionHTML": "Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"
Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.
OK
" } ] } ], "repo-deliveries": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries", "title": "List deliveries for a repository webhook", "category": "webhooks", "subcategory": "repo-deliveries", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "cursor", "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link header for the next and previous page cursors.
Response
", "example": [ { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-03T00:57:16Z", "redelivery": false, "duration": 0.27, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456 }, { "id": 123456789, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-04T00:57:16Z", "redelivery": true, "duration": 0.28, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456 } ], "schema": { "type": "array", "items": { "title": "Simple webhook delivery", "description": "Delivery made by a webhook, without request and response information.", "type": "object", "properties": { "id": { "description": "Unique identifier of the webhook delivery.", "type": "integer", "examples": [ 42 ] }, "guid": { "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", "type": "string", "examples": [ "58474f00-b361-11eb-836d-0e4f3503ccbe" ] }, "delivered_at": { "description": "Time when the webhook delivery occurred.", "type": "string", "format": "date-time", "examples": [ "2021-05-12T20:33:44Z" ] }, "redelivery": { "description": "Whether the webhook delivery is a redelivery.", "type": "boolean", "examples": [ false ] }, "duration": { "description": "Time spent delivering.", "type": "number", "examples": [ 0.03 ] }, "status": { "description": "Describes the response returned after attempting the delivery.", "type": "string", "examples": [ "failed to connect" ] }, "status_code": { "description": "Status code received when delivery was made.", "type": "integer", "examples": [ 502 ] }, "event": { "description": "The event that triggered the delivery.", "type": "string", "examples": [ "issues" ] }, "action": { "description": "The type of activity for the event that triggered the delivery.", "type": [ "string", "null" ], "examples": [ "opened" ] }, "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": [ "integer", "null" ], "examples": [ 123 ] }, "repository_id": { "description": "The id of the repository associated with this event.", "type": [ "integer", "null" ], "examples": [ 123 ] } }, "required": [ "id", "guid", "delivered_at", "redelivery", "duration", "status", "status_code", "event", "action", "installation_id", "repository_id" ] } } } } ], "previews": [], "descriptionHTML": "Returns a list of webhook deliveries for a webhook configured in a repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}", "title": "Get a delivery for a repository webhook", "category": "webhooks", "subcategory": "repo-deliveries", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID", "delivery_id": "DELIVERY_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-03T00:57:16Z", "redelivery": false, "duration": 0.27, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456, "url": "https://www.example.com", "request": { "headers": { "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "Accept": "*/*", "X-GitHub-Hook-ID": "42", "User-Agent": "GitHub-Hookshot/b8c71d8", "X-GitHub-Event": "issues", "X-GitHub-Hook-Installation-Target-ID": "123", "X-GitHub-Hook-Installation-Target-Type": "repository", "content-type": "application/json", "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" }, "payload": { "action": "opened", "issue": { "body": "foo" }, "repository": { "id": 123 } } }, "response": { "headers": { "Content-Type": "text/html;charset=utf-8" }, "payload": "ok" } }, "schema": { "title": "Webhook delivery", "description": "Delivery made by a webhook.", "type": "object", "properties": { "id": { "description": "Unique identifier of the delivery.", "type": "integer", "examples": [ 42 ] }, "guid": { "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", "type": "string", "examples": [ "58474f00-b361-11eb-836d-0e4f3503ccbe" ] }, "delivered_at": { "description": "Time when the delivery was delivered.", "type": "string", "format": "date-time", "examples": [ "2021-05-12T20:33:44Z" ] }, "redelivery": { "description": "Whether the delivery is a redelivery.", "type": "boolean", "examples": [ false ] }, "duration": { "description": "Time spent delivering.", "type": "number", "examples": [ 0.03 ] }, "status": { "description": "Description of the status of the attempted delivery", "type": "string", "examples": [ "failed to connect" ] }, "status_code": { "description": "Status code received when delivery was made.", "type": "integer", "examples": [ 502 ] }, "event": { "description": "The event that triggered the delivery.", "type": "string", "examples": [ "issues" ] }, "action": { "description": "The type of activity for the event that triggered the delivery.", "type": [ "string", "null" ], "examples": [ "opened" ] }, "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": [ "integer", "null" ], "examples": [ 123 ] }, "repository_id": { "description": "The id of the repository associated with this event.", "type": [ "integer", "null" ], "examples": [ 123 ] }, "url": { "description": "The URL target of the delivery.", "type": "string", "examples": [ "https://www.example.com" ] }, "request": { "type": "object", "properties": { "headers": { "description": "The request headers sent with the webhook delivery.", "type": [ "object", "null" ], "additionalProperties": true }, "payload": { "description": "The webhook payload.", "type": [ "object", "null" ], "additionalProperties": true } }, "required": [ "headers", "payload" ] }, "response": { "type": "object", "properties": { "headers": { "description": "The response headers received when the delivery was made.", "type": [ "object", "null" ], "additionalProperties": true }, "payload": { "description": "The response payload received.", "type": [ "string", "null" ], "additionalProperties": true } }, "required": [ "headers", "payload" ] } }, "required": [ "id", "guid", "delivered_at", "redelivery", "duration", "status", "status_code", "event", "action", "installation_id", "repository_id", "request", "response" ] } } } ], "previews": [], "descriptionHTML": "Returns a delivery for a webhook configured in a repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", "title": "Redeliver a delivery for a repository webhook", "category": "webhooks", "subcategory": "repo-deliveries", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID", "delivery_id": "DELIVERY_ID" } }, "response": { "statusCode": "202", "description": "Accepted
" } } ], "previews": [], "descriptionHTML": "Redeliver a webhook delivery for a webhook configured in a repository.
", "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "repos": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks", "title": "List repository webhooks", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "type": "Repository", "id": 12345678, "name": "web", "active": true, "events": [ "push", "pull_request" ], "config": { "content_type": "json", "insecure_ssl": "0", "url": "https://example.com/webhook" }, "updated_at": "2019-06-03T00:57:16Z", "created_at": "2019-06-03T00:57:16Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } } ], "schema": { "type": "array", "items": { "title": "Webhook", "description": "Webhooks for repositories.", "type": "object", "properties": { "type": { "type": "string" }, "id": { "description": "Unique identifier of the webhook.", "type": "integer", "examples": [ 42 ] }, "name": { "description": "The name of a valid service, use 'web' for a webhook.", "type": "string", "examples": [ "web" ] }, "active": { "description": "Determines whether the hook is actually triggered on pushes.", "type": "boolean", "examples": [ true ] }, "events": { "description": "Determines what events the hook is triggered for. Default: ['push'].", "type": "array", "items": { "type": "string" }, "examples": [ "push", "pull_request" ] }, "config": { "type": "object", "properties": { "email": { "type": "string", "examples": [ "\"foo@bar.com\"" ] }, "password": { "type": "string", "examples": [ "\"foo\"" ] }, "room": { "type": "string", "examples": [ "\"roomer\"" ] }, "subdomain": { "type": "string", "examples": [ "\"foo\"" ] }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "format": "uri", "examples": [ "https://example.com/webhook" ] }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "examples": [ "\"0\"" ] }, { "type": "number" } ] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ "\"json\"" ] }, "digest": { "type": "string", "examples": [ "\"sha256\"" ] }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] }, "token": { "type": "string", "examples": [ "\"abc\"" ] } } }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T20:39:23Z" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T17:26:27Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1" ] }, "test_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" ] }, "ping_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" ] }, "deliveries_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" ] }, "last_response": { "title": "Hook Response", "type": "object", "properties": { "code": { "type": [ "integer", "null" ] }, "status": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "code", "status", "message" ] } }, "required": [ "id", "url", "type", "name", "active", "events", "config", "ping_url", "created_at", "updated_at", "last_response", "test_url" ] } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks", "title": "Create a repository webhook", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } } ], "bodyParameters": [ { "type": "string", "name": "name", "in": "body", "description": "Use web to create a webhook. Default: web. This parameter only accepts the value web.
Key/value pairs to provide settings for this webhook. These are defined below.
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "The URL to which the payloads will be delivered.
" }, { "type": "string", "name": "content_type", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
Determines what events the hook is triggered for.
", "default": [ "push" ] }, { "type": "boolean", "name": "active", "in": "body", "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Response
", "example": { "type": "Repository", "id": 12345678, "name": "web", "active": true, "events": [ "push", "pull_request" ], "config": { "content_type": "json", "insecure_ssl": "0", "url": "https://example.com/webhook" }, "updated_at": "2019-06-03T00:57:16Z", "created_at": "2019-06-03T00:57:16Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } }, "schema": { "title": "Webhook", "description": "Webhooks for repositories.", "type": "object", "properties": { "type": { "type": "string" }, "id": { "description": "Unique identifier of the webhook.", "type": "integer", "examples": [ 42 ] }, "name": { "description": "The name of a valid service, use 'web' for a webhook.", "type": "string", "examples": [ "web" ] }, "active": { "description": "Determines whether the hook is actually triggered on pushes.", "type": "boolean", "examples": [ true ] }, "events": { "description": "Determines what events the hook is triggered for. Default: ['push'].", "type": "array", "items": { "type": "string" }, "examples": [ "push", "pull_request" ] }, "config": { "type": "object", "properties": { "email": { "type": "string", "examples": [ "\"foo@bar.com\"" ] }, "password": { "type": "string", "examples": [ "\"foo\"" ] }, "room": { "type": "string", "examples": [ "\"roomer\"" ] }, "subdomain": { "type": "string", "examples": [ "\"foo\"" ] }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "format": "uri", "examples": [ "https://example.com/webhook" ] }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "examples": [ "\"0\"" ] }, { "type": "number" } ] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ "\"json\"" ] }, "digest": { "type": "string", "examples": [ "\"sha256\"" ] }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] }, "token": { "type": "string", "examples": [ "\"abc\"" ] } } }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T20:39:23Z" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T17:26:27Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1" ] }, "test_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" ] }, "ping_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" ] }, "deliveries_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" ] }, "last_response": { "title": "Hook Response", "type": "object", "properties": { "code": { "type": [ "integer", "null" ] }, "status": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "code", "status", "message" ] } }, "required": [ "id", "url", "type", "name", "active", "events", "config", "ping_url", "created_at", "updated_at", "last_response", "test_url" ] } } } ], "previews": [], "descriptionHTML": "Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can\nshare the same config as long as those webhooks do not have any events that overlap.
Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", "title": "Get a repository webhook", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "type": "Repository", "id": 12345678, "name": "web", "active": true, "events": [ "push", "pull_request" ], "config": { "content_type": "json", "insecure_ssl": "0", "url": "https://example.com/webhook" }, "updated_at": "2019-06-03T00:57:16Z", "created_at": "2019-06-03T00:57:16Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } }, "schema": { "title": "Webhook", "description": "Webhooks for repositories.", "type": "object", "properties": { "type": { "type": "string" }, "id": { "description": "Unique identifier of the webhook.", "type": "integer", "examples": [ 42 ] }, "name": { "description": "The name of a valid service, use 'web' for a webhook.", "type": "string", "examples": [ "web" ] }, "active": { "description": "Determines whether the hook is actually triggered on pushes.", "type": "boolean", "examples": [ true ] }, "events": { "description": "Determines what events the hook is triggered for. Default: ['push'].", "type": "array", "items": { "type": "string" }, "examples": [ "push", "pull_request" ] }, "config": { "type": "object", "properties": { "email": { "type": "string", "examples": [ "\"foo@bar.com\"" ] }, "password": { "type": "string", "examples": [ "\"foo\"" ] }, "room": { "type": "string", "examples": [ "\"roomer\"" ] }, "subdomain": { "type": "string", "examples": [ "\"foo\"" ] }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "format": "uri", "examples": [ "https://example.com/webhook" ] }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "examples": [ "\"0\"" ] }, { "type": "number" } ] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ "\"json\"" ] }, "digest": { "type": "string", "examples": [ "\"sha256\"" ] }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] }, "token": { "type": "string", "examples": [ "\"abc\"" ] } } }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T20:39:23Z" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T17:26:27Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1" ] }, "test_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" ] }, "ping_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" ] }, "deliveries_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" ] }, "last_response": { "title": "Hook Response", "type": "object", "properties": { "code": { "type": [ "integer", "null" ] }, "status": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "code", "status", "message" ] } }, "required": [ "id", "url", "type", "name", "active", "events", "config", "ping_url", "created_at", "updated_at", "last_response", "test_url" ] } } } ], "previews": [], "descriptionHTML": "Returns a webhook configured in a repository. To get only the webhook config properties, see \"Get a webhook configuration for a repository.\"
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", "title": "Update a repository webhook", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [ { "type": "object", "name": "config", "in": "body", "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", "childParamsGroups": [ { "type": "string", "name": "url", "description": "The URL to which the payloads will be delivered.
", "isRequired": true }, { "type": "string", "name": "content_type", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
Determines what events the hook is triggered for. This replaces the entire array of events.
", "default": [ "push" ] }, { "type": "array of strings", "name": "add_events", "in": "body", "description": "Determines a list of events to be added to the list of events that the Hook triggers for.
" }, { "type": "array of strings", "name": "remove_events", "in": "body", "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.
" }, { "type": "boolean", "name": "active", "in": "body", "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Response
", "example": { "type": "Repository", "id": 12345678, "name": "web", "active": true, "events": [ "push", "pull_request" ], "config": { "content_type": "json", "insecure_ssl": "0", "url": "https://example.com/webhook" }, "updated_at": "2019-06-03T00:57:16Z", "created_at": "2019-06-03T00:57:16Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } }, "schema": { "title": "Webhook", "description": "Webhooks for repositories.", "type": "object", "properties": { "type": { "type": "string" }, "id": { "description": "Unique identifier of the webhook.", "type": "integer", "examples": [ 42 ] }, "name": { "description": "The name of a valid service, use 'web' for a webhook.", "type": "string", "examples": [ "web" ] }, "active": { "description": "Determines whether the hook is actually triggered on pushes.", "type": "boolean", "examples": [ true ] }, "events": { "description": "Determines what events the hook is triggered for. Default: ['push'].", "type": "array", "items": { "type": "string" }, "examples": [ "push", "pull_request" ] }, "config": { "type": "object", "properties": { "email": { "type": "string", "examples": [ "\"foo@bar.com\"" ] }, "password": { "type": "string", "examples": [ "\"foo\"" ] }, "room": { "type": "string", "examples": [ "\"roomer\"" ] }, "subdomain": { "type": "string", "examples": [ "\"foo\"" ] }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "format": "uri", "examples": [ "https://example.com/webhook" ] }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "examples": [ "\"0\"" ] }, { "type": "number" } ] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ "\"json\"" ] }, "digest": { "type": "string", "examples": [ "\"sha256\"" ] }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] }, "token": { "type": "string", "examples": [ "\"abc\"" ] } } }, "updated_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T20:39:23Z" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ "2011-09-06T17:26:27Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1" ] }, "test_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" ] }, "ping_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" ] }, "deliveries_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" ] }, "last_response": { "title": "Hook Response", "type": "object", "properties": { "code": { "type": [ "integer", "null" ] }, "status": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "code", "status", "message" ] } }, "required": [ "id", "url", "type", "name", "active", "events", "config", "ping_url", "created_at", "updated_at", "last_response", "test_url" ] } } } ], "previews": [], "descriptionHTML": "Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", "title": "Delete a repository webhook", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", "title": "Ping a repository webhook", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "This will trigger a ping event to be sent to the hook.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", "title": "Test the push repository webhook", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "description": "The unique identifier of the hook.
", "in": "path", "required": true, "schema": { "type": "integer" } } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note: Previously /repos/:owner/:repo/hooks/:hook_id/test
No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ] } }